Merge branch 'master' of http://darcs.haskell.org/ghc
[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 $checked_out_flag = 0;
69 my $get_mode;
70
71 my %tags;
72
73 # Figure out where to get the other repositories from.
74 sub getrepo {
75     my $basedir = ".";
76     my $repo;
77
78     if (defined($defaultrepo)) {
79         $repo = $defaultrepo;
80         chomp $repo;
81     } else {
82         # Figure out where to get the other repositories from,
83         # based on where this GHC repo came from.
84         my $branch = `git branch | grep "\* " | sed "s/^\* //"`; chomp $branch;
85         my $remote = `git config branch.$branch.remote`;         chomp $remote;
86         $repo = `git config remote.$remote.url`;       chomp $repo;
87     }
88
89     my $repo_base;
90     my $checked_out_tree;
91
92     if ($repo =~ /^...*:/) {
93         # HTTP or SSH
94         # Above regex says "at least two chars before the :", to avoid
95         # catching Win32 drives ("C:\").
96         $repo_base = $repo;
97
98         # --checked-out is needed if you want to use a checked-out repo
99         # over SSH or HTTP
100         if ($checked_out_flag) {
101             $checked_out_tree = 1;
102         } else {
103             $checked_out_tree = 0;
104         }
105
106         # Don't drop the last part of the path if specified with -r, as
107         # it expects repos of the form:
108         #
109         #   http://darcs.haskell.org
110         #
111         # rather than
112         #   
113         #   http://darcs.haskell.org/ghc
114         #
115         if (!$defaultrepo) {
116             $repo_base =~ s#/[^/]+/?$##;
117         }
118     }
119     elsif ($repo =~ /^\/|\.\.\/|.:(\/|\\)/) {
120         # Local filesystem, either absolute or relative path
121         # (assumes a checked-out tree):
122         $repo_base = $repo;
123         $checked_out_tree = 1;
124     }
125     else {
126         die "Couldn't work out repo";
127     }
128
129     return $repo_base, $checked_out_tree;
130 }
131
132 sub parsePackages {
133     my @repos;
134     my $lineNum;
135
136     open IN, "< packages" or die "Can't open packages file";
137     @repos = <IN>;
138     close IN;
139
140     @packages = ();
141     $lineNum = 0;
142     foreach (@repos) {
143         chomp;
144         $lineNum++;
145         if (/^([^# ]+) +([^ ]+) +([^ ]+) +([^ ]+) +([^ ]+)$/) {
146             my %line;
147             $line{"localpath"}  = $1;
148             $line{"tag"}        = $2;
149             $line{"remotepath"} = $3;
150             $line{"vcs"}        = $4;
151             $line{"upstream"}   = $5;
152             push @packages, \%line;
153         }
154         elsif (! /^(#.*)?$/) {
155             die "Bad content on line $lineNum of packages file: $_";
156         }
157     }
158 }
159
160 sub message {
161     if ($verbose >= 2) {
162         print "@_\n";
163     }
164 }
165
166 sub warning {
167     if ($verbose >= 1) {
168         print "warning: @_\n";
169     }
170 }
171
172 sub scm {
173     my $dir = shift;
174     my $scm = shift;
175     my $pwd;
176
177     if ($dir eq '.') {
178         message "== running $scm @_";
179     } else {
180         message "== $dir: running $scm @_";
181         $pwd = getcwd();
182         chdir($dir);
183     }
184
185     system ($scm, @_) == 0
186         or $ignore_failure
187         or die "$scm failed: $?";
188
189     if ($dir ne '.') {
190         chdir($pwd);
191     }
192 }
193
194 sub scmall {
195     my $command = shift;
196     
197     my $localpath;
198     my $tag;
199     my $remotepath;
200     my $scm;
201     my $upstream;
202     my $line;
203     my $branch_name;
204     my $subcommand;
205
206     my $path;
207     my $wd_before = getcwd;
208
209     my $pwd;
210     my @args;
211
212     my ($repo_base, $checked_out_tree) = getrepo();
213
214     my $is_github_repo = $repo_base =~ m/(git@|git:\/\/|https:\/\/)github.com/;
215
216     parsePackages;
217
218     @args = ();
219
220     if ($command =~ /^remote$/) {
221         while (@_ > 0 && $_[0] =~ /^-/) {
222             push(@args,shift);
223         }
224         if (@_ < 1) { help(); }
225         $subcommand = shift;
226         if ($subcommand ne 'add' && $subcommand ne 'rm' && $subcommand ne 'set-url') {
227             help();
228         }
229         while (@_ > 0 && $_[0] =~ /^-/) {
230             push(@args,shift);
231         }
232         if (($subcommand eq 'add' || $subcommand eq 'rm') && @_ < 1) {
233             help();
234         } elsif (@_ < 1) { # set-url
235             $branch_name = 'origin';
236         } else {
237             $branch_name = shift;
238         }
239     } elsif ($command eq 'new') {
240         if (@_ < 1) {
241             $branch_name = 'origin';
242         } else {
243             $branch_name = shift;
244         }
245     }
246
247     push(@args, @_);
248
249     for $line (@packages) {
250
251         $localpath  = $$line{"localpath"};
252         $tag        = $$line{"tag"};
253         $remotepath = $$line{"remotepath"};
254         $scm        = $$line{"vcs"};
255         $upstream   = $$line{"upstream"};
256
257         # Check the SCM is OK as early as possible
258         die "Unknown SCM: $scm" if (($scm ne "darcs") and ($scm ne "git"));
259
260         # We can't create directories on GitHub, so we translate
261         # "package/foo" into "package-foo".
262         if ($is_github_repo) {
263             $remotepath =~ s/\//-/;
264         }
265
266         # Work out the path for this package in the repo we pulled from
267         if ($checked_out_tree) {
268             $path = "$repo_base/$localpath";
269         }
270         else {
271             $path = "$repo_base/$remotepath";
272         }
273
274         if ($command =~ /^(?:g|ge|get)$/) {
275             # Skip any repositories we have not included the tag for
276             if (not defined($tags{$tag})) {
277                 $tags{$tag} = 0;
278             }
279             if ($tags{$tag} == 0) {
280                 next;
281             }
282             
283             if (-d $localpath) {
284                 warning("$localpath already present; omitting")
285                     if $localpath ne ".";
286                 if ($scm eq "git") {
287                     scm ($localpath, $scm, "config", "core.ignorecase", "true");
288                 }
289                 next;
290             }
291
292             # Note that we use "." as the path, as $localpath
293             # doesn't exist yet.
294             if ($scm eq "darcs") {
295                 # The first time round the loop, default the get-mode
296                 if (not defined($get_mode)) {
297                     warning("adding --partial, to override use --complete");
298                     $get_mode = "--partial";
299                 }
300                 scm (".", $scm, "get", $get_mode, $path, $localpath, @args);
301             }
302             else {
303                 scm (".", $scm, "clone", $path, $localpath, @args);
304                 scm ($localpath, $scm, "config", "core.ignorecase", "true");
305             }
306             next;
307         }
308
309         if (-d "$localpath/_darcs") {
310             if (-d "$localpath/.git") {
311                 die "Found both _darcs and .git in $localpath";
312             }
313             $scm = "darcs";
314         } elsif (-d "$localpath/.git") {
315             $scm = "git";
316         } elsif ($tag eq "") {
317             die "Required repo $localpath is missing";
318         } else {
319              message "== $localpath repo not present; skipping";
320              next;
321         }
322
323         # Work out the arguments we should give to the SCM
324         if ($command =~ /^(?:w|wh|wha|what|whats|whatsn|whatsne|whatsnew|status)$/) {
325             if ($scm eq "darcs") {
326                 $command = "whatsnew";
327             }
328             elsif ($scm eq "git") {
329                 $command = "status";
330             }
331             else {
332                 die "Unknown scm";
333             }
334
335             # Hack around 'darcs whatsnew' failing if there are no changes
336             $ignore_failure = 1;
337             scm ($localpath, $scm, $command, @args);
338         }
339         elsif ($command =~ /^commit$/) {
340             # git fails if there is nothing to commit, so ignore failures
341             $ignore_failure = 1;
342             scm ($localpath, $scm, "commit", @args);
343         }
344         elsif ($command =~ /^(?:pus|push)$/) {
345             scm ($localpath, $scm, "push", @args);
346         }
347         elsif ($command =~ /^(?:pul|pull)$/) {
348             scm ($localpath, $scm, "pull", @args);
349         }
350         elsif ($command =~ /^(?:s|se|sen|send)$/) {
351             if ($scm eq "darcs") {
352                 $command = "send";
353             }
354             elsif ($scm eq "git") {
355                 $command = "send-email";
356             }
357             else {
358                 die "Unknown scm";
359             }
360             scm ($localpath, $scm, $command, @args);
361         }
362         elsif ($command =~ /^fetch$/) {
363             scm ($localpath, $scm, "fetch", @args);
364         }
365         elsif ($command =~ /^new$/) {
366             my @scm_args = ("log", "$branch_name..");
367             scm ($localpath, $scm, @scm_args, @args);
368         }
369         elsif ($command =~ /^remote$/) {
370             my @scm_args;
371             if ($subcommand eq 'add') {
372                 @scm_args = ("remote", "add", $branch_name, $path);
373             } elsif ($subcommand eq 'rm') {
374                 @scm_args = ("remote", "rm", $branch_name);
375             } elsif ($subcommand eq 'set-url') {
376                 @scm_args = ("remote", "set-url", $branch_name, $path);
377             }
378             scm ($localpath, $scm, @scm_args, @args);
379         }
380         elsif ($command =~ /^checkout$/) {
381             # Not all repos are necessarily branched, so ignore failure
382             $ignore_failure = 1;
383             scm ($localpath, $scm, "checkout", @args)
384                 unless $scm eq "darcs";
385         }
386         elsif ($command =~ /^grep$/) {
387             # Hack around 'git grep' failing if there are no matches
388             $ignore_failure = 1;
389             scm ($localpath, $scm, "grep", @args)
390                 unless $scm eq "darcs";
391         }
392         elsif ($command =~ /^clean$/) {
393             scm ($localpath, $scm, "clean", @args)
394                 unless $scm eq "darcs";
395         }
396         elsif ($command =~ /^reset$/) {
397             scm ($localpath, $scm, "reset", @args)
398                 unless $scm eq "darcs";
399         }
400         elsif ($command =~ /^config$/) {
401             scm ($localpath, $scm, "config", @args)
402                 unless $scm eq "darcs";
403         }
404         else {
405             die "Unknown command: $command";
406         }
407     }
408 }
409
410
411 sub help()
412 {
413         # Get the built in help
414         my $help = <<END;
415 What do you want to do?
416 Supported commands:
417
418  * whatsnew
419  * commit
420  * push
421  * pull
422  * get, with options:
423   * --<package-tag>
424   * --complete
425   * --partial
426  * fetch
427  * send
428  * new
429  * remote add <branch-name>
430  * remote rm <branch-name>
431  * remote set-url [--push] <branch-name>
432  * checkout
433  * grep
434  * clean
435  * reset
436  * config
437
438 Available package-tags are:
439 END
440
441         # Collect all the tags in the packages file
442         my %available_tags;
443         open IN, "< packages" or die "Can't open packages file";
444         while (<IN>) {
445             chomp;
446             if (/^([^# ]+) +(?:([^ ]+) +)?([^ ]+) +([^ ]+)/) {
447                 if (defined($2) && $2 ne "-") {
448                     $available_tags{$2} = 1;
449                 }
450             }
451             elsif (! /^(#.*)?$/) {
452                 die "Bad line: $_";
453             }
454         }
455         close IN;
456         
457         # Show those tags and the help text
458         my @available_tags = keys %available_tags;
459         print "$help@available_tags\n";
460         exit 1;
461 }
462
463 sub main {
464     if (! -d ".git" || ! -d "compiler") {
465         die "error: sync-all must be run from the top level of the ghc tree."
466     }
467
468     $tags{"-"} = 1;
469     $tags{"dph"} = 1;
470
471     while ($#_ ne -1) {
472         my $arg = shift;
473         # We handle -q here as well as lower down as we need to skip over it
474         # if it comes before the source-control command
475         if ($arg eq "-q") {
476             $verbose = 1;
477         }
478         elsif ($arg eq "-s") {
479             $verbose = 0;
480         }
481         elsif ($arg eq "-r") {
482             $defaultrepo = shift;
483         }
484         elsif ($arg eq "--ignore-failure") {
485             $ignore_failure = 1;
486         }
487         elsif ($arg eq "--complete" || $arg eq "--partial") {
488             $get_mode = $arg;
489         }
490         # Use --checked-out if the remote repos are a checked-out tree,
491         # rather than the master trees.
492         elsif ($arg eq "--checked-out") {
493             $checked_out_flag = 1;
494         }
495         # --<tag> says we grab the libs tagged 'tag' with
496         # 'get'. It has no effect on the other commands.
497         elsif ($arg =~ m/^--no-(.*)$/) {
498             $tags{$1} = 0;
499         }
500         elsif ($arg =~ m/^--(.*)$/) {
501             $tags{$1} = 1;
502         }
503         else {
504             unshift @_, $arg;
505             if (grep /^-q$/, @_) {
506                 $verbose = 1;
507             }
508             last;
509         }
510     }
511
512     if ($#_ eq -1) {
513         help();
514     }
515     else {
516         # Give the command and rest of the arguments to the main loop
517         scmall @_;
518     }
519 }
520
521 main(@ARGV);
522