d20f4e7ff6f05a439e4ed7c700c9f869d054ada8
[ghc.git] / sync-all
1 #!/usr/bin/perl -w
2
3 use strict;
4 use Cwd;
5
6 # Usage:
7 #
8 # ./sync-all [-q] [-s] [--ignore-failure] [-r repo]
9 #            [--nofib] [--testsuite] [--checked-out] cmd [git flags]
10 #
11 # Applies the command "cmd" to each repository in the tree.
12 # sync-all will try to do the right thing for both git and darcs repositories.
13 #
14 # e.g.
15 #      ./sync-all -r http://darcs.haskell.org/ghc get
16 #          To get any repos which do not exist in the local tree
17 #
18 #      ./sync-all pull
19 #          To pull everything from the default repos
20 #
21 # -------------- Flags -------------------
22 #   -q says to be quite, and -s to be silent.
23 #
24 #   --ignore-failure says to ignore errors and move on to the next repository
25 #
26 #   -r repo says to use repo as the location of package repositories
27 #
28 #   --checked-out says that the remote repo is in checked-out layout, as
29 #   opposed to the layout used for the main repo.  By default a repo on
30 #   the local filesystem is assumed to be checked-out, and repos accessed
31 #   via HTTP or SSH are assumed to be in the main repo layout; use
32 #   --checked-out to override the latter.
33 #
34 #   --nofib, --testsuite also get the nofib and testsuite repos respectively
35 #
36 # ------------ Which repos to use -------------
37 # sync-all uses the following algorithm to decide which remote repos to use
38 #
39 #  It always computes the remote repos from a single base, $repo_base
40 #  How is $repo_base set?  
41 #    If you say "-r repo", then that's $repo_base
42 #    otherwise $repo_base is set by asking git where the ghc repo came
43 #    from, and removing the last component (e.g. /ghc.git/ of /ghc/).
44 #
45 #  Then sync-all iterates over the package found in the file
46 #  ./packages; see that file for a description of the contents.
47
48 #    If $repo_base looks like a local filesystem path, or if you give
49 #    the --checked-out flag, sync-all works on repos of form
50 #          $repo_base/<local-path>
51 #    otherwise sync-all works on repos of form
52 #          $repo_base/<remote-path>
53 #    This logic lets you say
54 #      both    sync-all -r http://darcs.haskell.org/ghc-6.12 pull
55 #      and     sync-all -r ../HEAD pull
56 #    The latter is called a "checked-out tree".
57
58 # NB: sync-all *ignores* the defaultrepo of all repos other than the
59 # root one.  So the remote repos must be laid out in one of the two
60 # formats given by <local-path> and <remote-path> in the file 'packages'.
61
62 $| = 1; # autoflush stdout after each print, to avoid output after die
63
64 my $defaultrepo;
65 my @packages;
66 my $verbose = 2;
67 my $ignore_failure = 0;
68 my $want_remote_repo = 0;
69 my $checked_out_flag = 0;
70 my $get_mode;
71
72 # Flags specific to a particular command
73 my $local_repo_unnecessary = 0;
74
75 my %tags;
76
77 # Figure out where to get the other repositories from.
78 sub getrepo {
79     my $basedir = ".";
80     my $repo;
81
82     if (defined($defaultrepo)) {
83         $repo = $defaultrepo;
84         chomp $repo;
85     } else {
86         # Figure out where to get the other repositories from,
87         # based on where this GHC repo came from.
88         my $branch = `git branch | grep "\* " | sed "s/^\* //"`; chomp $branch;
89         my $remote = `git config branch.$branch.remote`;         chomp $remote;
90         $repo = `git config remote.$remote.url`;       chomp $repo;
91     }
92
93     my $repo_base;
94     my $checked_out_tree;
95
96     if ($repo =~ /^...*:/) {
97         # HTTP or SSH
98         # Above regex says "at least two chars before the :", to avoid
99         # catching Win32 drives ("C:\").
100         $repo_base = $repo;
101
102         # --checked-out is needed if you want to use a checked-out repo
103         # over SSH or HTTP
104         if ($checked_out_flag) {
105             $checked_out_tree = 1;
106         } else {
107             $checked_out_tree = 0;
108         }
109
110         # Don't drop the last part of the path if specified with -r, as
111         # it expects repos of the form:
112         #
113         #   http://darcs.haskell.org
114         #
115         # rather than
116         #   
117         #   http://darcs.haskell.org/ghc
118         #
119         if (!$defaultrepo) {
120             $repo_base =~ s#/[^/]+/?$##;
121         }
122     }
123     elsif ($repo =~ /^\/|\.\.\/|.:(\/|\\)/) {
124         # Local filesystem, either absolute or relative path
125         # (assumes a checked-out tree):
126         $repo_base = $repo;
127         $checked_out_tree = 1;
128     }
129     else {
130         die "Couldn't work out repo";
131     }
132
133     return $repo_base, $checked_out_tree;
134 }
135
136 sub parsePackages {
137     my @repos;
138     my $lineNum;
139
140     open IN, "< packages" or die "Can't open packages file";
141     @repos = <IN>;
142     close IN;
143
144     @packages = ();
145     $lineNum = 0;
146     foreach (@repos) {
147         chomp;
148         $lineNum++;
149         if (/^([^# ]+) +([^ ]+) +([^ ]+) +([^ ]+) +([^ ]+)$/) {
150             my %line;
151             $line{"localpath"}  = $1;
152             $line{"tag"}        = $2;
153             $line{"remotepath"} = $3;
154             $line{"vcs"}        = $4;
155             $line{"upstream"}   = $5;
156             push @packages, \%line;
157         }
158         elsif (! /^(#.*)?$/) {
159             die "Bad content on line $lineNum of packages file: $_";
160         }
161     }
162 }
163
164 sub message {
165     if ($verbose >= 2) {
166         print "@_\n";
167     }
168 }
169
170 sub warning {
171     if ($verbose >= 1) {
172         print "warning: @_\n";
173     }
174 }
175
176 sub scm {
177     my $dir = shift;
178     my $scm = shift;
179     my $pwd;
180
181     if ($dir eq '.') {
182         message "== running $scm @_";
183     } else {
184         message "== $dir: running $scm @_";
185         $pwd = getcwd();
186         chdir($dir);
187     }
188
189     system ($scm, @_) == 0
190         or $ignore_failure
191         or die "$scm failed: $?";
192
193     if ($dir ne '.') {
194         chdir($pwd);
195     }
196 }
197
198 sub repoexists {
199     my ($scm, $localpath) = @_;
200     
201     if ($scm eq "darcs") {
202         -d "$localpath/_darcs";
203     }
204     else {
205         -d "$localpath/.git";
206     }
207 }
208
209 sub scmall {
210     my $command = shift;
211     
212     my $localpath;
213     my $tag;
214     my $remotepath;
215     my $scm;
216     my $upstream;
217     my $line;
218     my $branch_name;
219     my $subcommand;
220
221     my $path;
222     my $wd_before = getcwd;
223
224     my @scm_args;
225
226     my $pwd;
227     my @args;
228
229     my ($repo_base, $checked_out_tree) = getrepo();
230
231     my $is_github_repo = $repo_base =~ m/(git@|git:\/\/|https:\/\/)github.com/;
232
233     parsePackages;
234
235     @args = ();
236
237     if ($command =~ /^remote$/) {
238         while (@_ > 0 && $_[0] =~ /^-/) {
239             push(@args,shift);
240         }
241         if (@_ < 1) { help(); }
242         $subcommand = shift;
243         if ($subcommand ne 'add' && $subcommand ne 'rm' && $subcommand ne 'set-url') {
244             help();
245         }
246         while (@_ > 0 && $_[0] =~ /^-/) {
247             push(@args,shift);
248         }
249         if (($subcommand eq 'add' || $subcommand eq 'rm') && @_ < 1) {
250             help();
251         } elsif (@_ < 1) { # set-url
252             $branch_name = 'origin';
253         } else {
254             $branch_name = shift;
255         }
256     } elsif ($command eq 'new' || $command eq 'fetch') {
257         if (@_ < 1) {
258             $branch_name = 'origin';
259         } else {
260             $branch_name = shift;
261         }
262     }
263
264     push(@args, @_);
265
266     for $line (@packages) {
267
268             $localpath  = $$line{"localpath"};
269             $tag        = $$line{"tag"};
270             $remotepath = $$line{"remotepath"};
271             $scm        = $$line{"vcs"};
272             $upstream   = $$line{"upstream"};
273
274             # We can't create directories on GitHub, so we translate
275             # "package/foo" into "package-foo".
276             if ($is_github_repo) {
277                 $remotepath =~ s/\//-/;
278             }
279
280             # Check the SCM is OK as early as possible
281             die "Unknown SCM: $scm" if (($scm ne "darcs") and ($scm ne "git"));
282
283             # Work out the path for this package in the repo we pulled from
284             if ($checked_out_tree) {
285                 $path = "$repo_base/$localpath";
286             }
287             else {
288                 $path = "$repo_base/$remotepath";
289             }
290
291             # Work out the arguments we should give to the SCM
292             if ($command =~ /^(?:w|wh|wha|what|whats|whatsn|whatsne|whatsnew|status)$/) {
293                 @scm_args = (($scm eq "darcs" and "whatsnew")
294                           or ($scm eq "git" and "status"));
295                 
296                 # Hack around 'darcs whatsnew' failing if there are no changes
297                 $ignore_failure = 1;
298             }
299             elsif ($command =~ /^(?:pus|push)$/) {
300                 @scm_args = "push";
301                 $want_remote_repo = 1;
302             }
303             elsif ($command =~ /^(?:pul|pull)$/) {
304                 @scm_args = "pull";
305                 $want_remote_repo = 1;
306                 # Q: should we append the -a argument for darcs repos?
307             }
308             elsif ($command =~ /^(?:g|ge|get)$/) {
309                 # Skip any repositories we have not included the tag for
310                 if (not defined($tags{$tag})) {
311                     next;
312                 }
313                 
314                 if (-d $localpath) {
315                     warning("$localpath already present; omitting") if $localpath ne ".";
316                     next;
317                 }
318                 
319                 # The first time round the loop, default the get-mode
320                 if ($scm eq "darcs" && not defined($get_mode)) {
321                     warning("adding --partial, to override use --complete");
322                     $get_mode = "--partial";
323                 }
324                 
325                 # The only command that doesn't need a repo
326                 $local_repo_unnecessary = 1;
327                 
328                 if ($scm eq "darcs") {
329                     # Note: we can only use the get-mode with darcs for now
330                     @scm_args = ("get", $get_mode, $path, $localpath);
331                 }
332                 else {
333                     @scm_args = ("clone", $path, $localpath);
334                 }
335             }
336             elsif ($command =~ /^(?:s|se|sen|send)$/) {
337                 @scm_args = (($scm eq "darcs" and "send")
338                           or ($scm eq "git" and "send-email"));
339                 $want_remote_repo = 1;
340             }
341             elsif ($command =~ /^fetch$/) {
342                 @scm_args = ("fetch", "$branch_name");
343             }
344             elsif ($command =~ /^new$/) {
345                 @scm_args = ("log", "$branch_name..");
346             }
347             elsif ($command =~ /^remote$/) {
348                 if ($subcommand eq 'add') {
349                     @scm_args = ("remote", "add", $branch_name, $path);
350                 } elsif ($subcommand eq 'rm') {
351                     @scm_args = ("remote", "rm", $branch_name);
352                 } elsif ($subcommand eq 'set-url') {
353                     @scm_args = ("remote", "set-url", $branch_name, $path);
354                 }
355             }
356             elsif ($command =~ /^grep$/) {
357               @scm_args = ("grep");
358               # Hack around 'git grep' failing if there are no matches
359               $ignore_failure = 1;
360             }
361             else {
362                 die "Unknown command: $command";
363             }
364             
365             # Actually execute the command
366             if (repoexists ($scm, $localpath)) {
367                 if ($want_remote_repo) {
368                     if ($scm eq "darcs") {
369                         scm (".", $scm, @scm_args, @args, "--repodir=$localpath", $path);
370                     } else {
371                         # git pull doesn't like to be used with --work-dir
372                         # I couldn't find an alternative to chdir() here
373                         scm ($localpath, $scm, @scm_args, @args, $path, "master");
374                     }
375                 } else {
376                     # git status *must* be used with --work-dir, if we don't chdir() to the dir
377                     scm ($localpath, $scm, @scm_args, @args);
378                 }
379             }
380             elsif ($local_repo_unnecessary) {
381                 # Don't bother to change directory in this case
382                 scm (".", $scm, @scm_args, @args);
383             }
384             elsif ($tag eq "") {
385                 message "== Required repo $localpath is missing! Skipping";
386             }
387             else {
388                 message "== $localpath repo not present; skipping";
389             }
390     }
391 }
392
393
394 sub help()
395 {
396         # Get the built in help
397         my $help = <<END;
398 What do you want to do?
399 Supported commands:
400
401  * whatsnew
402  * push
403  * pull
404  * get, with options:
405   * --<package-tag>
406   * --complete
407   * --partial
408  * fetch
409  * send
410  * new
411  * remote add <branch-name>
412  * remote rm <branch-name>
413  * remote set-url [--push] <branch-name>
414  * grep
415
416 Available package-tags are:
417 END
418
419         # Collect all the tags in the packages file
420         my %available_tags;
421         open IN, "< packages" or die "Can't open packages file";
422         while (<IN>) {
423             chomp;
424             if (/^([^# ]+) +(?:([^ ]+) +)?([^ ]+) +([^ ]+)/) {
425                 if (defined($2) && $2 ne "-") {
426                     $available_tags{$2} = 1;
427                 }
428             }
429             elsif (! /^(#.*)?$/) {
430                 die "Bad line: $_";
431             }
432         }
433         close IN;
434         
435         # Show those tags and the help text
436         my @available_tags = keys %available_tags;
437         print "$help@available_tags\n";
438         exit 1;
439 }
440
441 sub main {
442     if (! -d ".git" || ! -d "compiler") {
443         die "error: sync-all must be run from the top level of the ghc tree."
444     }
445
446     $tags{"-"} = 1;
447     $tags{"dph"} = 1;
448
449     while ($#_ ne -1) {
450         my $arg = shift;
451         # We handle -q here as well as lower down as we need to skip over it
452         # if it comes before the source-control command
453         if ($arg eq "-q") {
454             $verbose = 1;
455         }
456         elsif ($arg eq "-s") {
457             $verbose = 0;
458         }
459         elsif ($arg eq "-r") {
460             $defaultrepo = shift;
461         }
462         elsif ($arg eq "--ignore-failure") {
463             $ignore_failure = 1;
464         }
465         elsif ($arg eq "--complete" || $arg eq "--partial") {
466             $get_mode = $arg;
467         }
468         # Use --checked-out if the remote repos are a checked-out tree,
469         # rather than the master trees.
470         elsif ($arg eq "--checked-out") {
471             $checked_out_flag = 1;
472         }
473         # --<tag> says we grab the libs tagged 'tag' with
474         # 'get'. It has no effect on the other commands.
475         elsif ($arg =~ m/^--/) {
476             $arg =~ s/^--//;
477             $tags{$arg} = 1;
478         }
479         else {
480             unshift @_, $arg;
481             if (grep /^-q$/, @_) {
482                 $verbose = 1;
483             }
484             last;
485         }
486     }
487
488     if ($#_ eq -1) {
489         help();
490     }
491     else {
492         # Give the command and rest of the arguments to the main loop
493         scmall @_;
494     }
495 }
496
497 main(@ARGV);
498