sync-all 13.8 KB
Newer Older
1 2 3 4 5
#!/usr/bin/perl -w

use strict;
use Cwd;

6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61
# Usage:
#
# ./sync-all [-q] [-s] [--ignore-failure] [-r repo]
#            [--nofib] [--testsuite] [--checked-out] cmd [git flags]
#
# Applies the command "cmd" to each repository in the tree.
# sync-all will try to do the right thing for both git and darcs repositories.
#
# e.g.
#      ./sync-all -r http://darcs.haskell.org/ghc get
#          To get any repos which do not exist in the local tree
#
#      ./sync-all pull
#          To pull everything from the default repos
#
# -------------- Flags -------------------
#   -q says to be quite, and -s to be silent.
#
#   --ignore-failure says to ignore errors and move on to the next repository
#
#   -r repo says to use repo as the location of package repositories
#
#   --checked-out says that the remote repo is in checked-out layout, as
#   opposed to the layout used for the main repo.  By default a repo on
#   the local filesystem is assumed to be checked-out, and repos accessed
#   via HTTP or SSH are assumed to be in the main repo layout; use
#   --checked-out to override the latter.
#
#   --nofib, --testsuite also get the nofib and testsuite repos respectively
#
# ------------ Which repos to use -------------
# sync-all uses the following algorithm to decide which remote repos to use
#
#  It always computes the remote repos from a single base, $repo_base
#  How is $repo_base set?  
#    If you say "-r repo", then that's $repo_base
#    otherwise $repo_base is set by asking git where the ghc repo came
#    from, and removing the last component (e.g. /ghc.git/ of /ghc/).
#
#  Then sync-all iterates over the package found in the file
#  ./packages; see that file for a description of the contents.
# 
#    If $repo_base looks like a local filesystem path, or if you give
#    the --checked-out flag, sync-all works on repos of form
#          $repo_base/<local-path>
#    otherwise sync-all works on repos of form
#          $repo_base/<remote-path>
#    This logic lets you say
#      both    sync-all -r http://darcs.haskell.org/ghc-6.12 pull
#      and     sync-all -r ../HEAD pull
#    The latter is called a "checked-out tree".

# NB: sync-all *ignores* the defaultrepo of all repos other than the
# root one.  So the remote repos must be laid out in one of the two
# formats given by <local-path> and <remote-path> in the file 'packages'.

Ian Lynagh's avatar
Ian Lynagh committed
62 63
$| = 1; # autoflush stdout after each print, to avoid output after die

Simon Marlow's avatar
Simon Marlow committed
64
my $defaultrepo;
Simon Marlow's avatar
Simon Marlow committed
65
my @packages;
66
my $verbose = 2;
Simon Marlow's avatar
Simon Marlow committed
67 68 69
my $ignore_failure = 0;
my $want_remote_repo = 0;
my $checked_out_flag = 0;
70 71 72 73 74 75
my $get_mode;

# Flags specific to a particular command
my $local_repo_unnecessary = 0;

my %tags;
Simon Marlow's avatar
Simon Marlow committed
76 77 78 79

# Figure out where to get the other repositories from.
sub getrepo {
    my $basedir = ".";
Simon Marlow's avatar
Simon Marlow committed
80 81 82 83 84 85 86 87 88 89 90 91
    my $repo;

    if (defined($defaultrepo)) {
        $repo = $defaultrepo;
        chomp $repo;
    } else {
        # Figure out where to get the other repositories from,
        # based on where this GHC repo came from.
        my $branch = `git branch | grep "\* " | sed "s/^\* //"`; chomp $branch;
        my $remote = `git config branch.$branch.remote`;         chomp $remote;
        $repo = `git config remote.$remote.url`;       chomp $repo;
    }
Simon Marlow's avatar
Simon Marlow committed
92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139

    my $repo_base;
    my $checked_out_tree;

    if ($repo =~ /^...*:/) {
        # HTTP or SSH
        # Above regex says "at least two chars before the :", to avoid
        # catching Win32 drives ("C:\").
        $repo_base = $repo;

        # --checked-out is needed if you want to use a checked-out repo
        # over SSH or HTTP
        if ($checked_out_flag) {
            $checked_out_tree = 1;
        } else {
            $checked_out_tree = 0;
        }

        # Don't drop the last part of the path if specified with -r, as
        # it expects repos of the form:
        #
        #   http://darcs.haskell.org
        #
        # rather than
        #   
        #   http://darcs.haskell.org/ghc
        #
        if (!$defaultrepo) {
            $repo_base =~ s#/[^/]+/?$##;
        }
    }
    elsif ($repo =~ /^\/|\.\.\/|.:(\/|\\)/) {
        # Local filesystem, either absolute or relative path
        # (assumes a checked-out tree):
        $repo_base = $repo;
        $checked_out_tree = 1;
    }
    else {
        die "Couldn't work out repo";
    }

    return $repo_base, $checked_out_tree;
}

sub parsePackages {
    my @repos;
    my $lineNum;

Ian Lynagh's avatar
Ian Lynagh committed
140
    open IN, "< packages" or die "Can't open packages file";
Simon Marlow's avatar
Simon Marlow committed
141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162
    @repos = <IN>;
    close IN;

    @packages = ();
    $lineNum = 0;
    foreach (@repos) {
        chomp;
        $lineNum++;
        if (/^([^# ]+) +([^ ]+) +([^ ]+) +([^ ]+) +([^ ]+)$/) {
            my %line;
            $line{"localpath"}  = $1;
            $line{"tag"}        = $2;
            $line{"remotepath"} = $3;
            $line{"vcs"}        = $4;
            $line{"upstream"}   = $5;
            push @packages, \%line;
        }
        elsif (! /^(#.*)?$/) {
            die "Bad content on line $lineNum of packages file: $_";
        }
    }
}
163 164 165 166 167 168 169 170 171 172 173 174 175 176

sub message {
    if ($verbose >= 2) {
        print "@_\n";
    }
}

sub warning {
    if ($verbose >= 1) {
        print "warning: @_\n";
    }
}

sub scm {
Simon Marlow's avatar
Simon Marlow committed
177
    my $dir = shift;
178
    my $scm = shift;
Simon Marlow's avatar
Simon Marlow committed
179 180 181 182 183 184 185 186 187 188
    my $pwd;

    if ($dir eq '.') {
        message "== running $scm @_";
    } else {
        message "== $dir: running $scm @_";
        $pwd = getcwd();
        chdir($dir);
    }

189 190 191
    system ($scm, @_) == 0
        or $ignore_failure
        or die "$scm failed: $?";
Simon Marlow's avatar
Simon Marlow committed
192 193 194 195

    if ($dir ne '.') {
        chdir($pwd);
    }
196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215
}

sub repoexists {
    my ($scm, $localpath) = @_;
    
    if ($scm eq "darcs") {
        -d "$localpath/_darcs";
    }
    else {
        -d "$localpath/.git";
    }
}

sub scmall {
    my $command = shift;
    
    my $localpath;
    my $tag;
    my $remotepath;
    my $scm;
216
    my $upstream;
Simon Marlow's avatar
Simon Marlow committed
217
    my $line;
218 219
    my $branch_name;
    my $subcommand;
220 221 222 223 224 225

    my $path;
    my $wd_before = getcwd;

    my @scm_args;

Simon Marlow's avatar
Simon Marlow committed
226
    my $pwd;
227
    my @args;
Simon Marlow's avatar
Simon Marlow committed
228

Simon Marlow's avatar
Simon Marlow committed
229 230 231 232
    my ($repo_base, $checked_out_tree) = getrepo();

    parsePackages;

233 234
    @args = ();

235
    if ($command =~ /^remote$/) {
236 237
        while (@_ > 0 && $_[0] =~ /^-/) {
            push(@args,shift);
238
        }
239
        if (@_ < 1) { help(); }
240
        $subcommand = shift;
241
        if ($subcommand ne 'add' && $subcommand ne 'rm' && $subcommand ne 'set-url') {
242 243
            help();
        }
244 245 246 247 248 249 250 251 252 253
        while (@_ > 0 && $_[0] =~ /^-/) {
            push(@args,shift);
        }
        if (($subcommand eq 'add' || $subcommand eq 'rm') && @_ < 1) {
            help();
        } elsif (@_ < 1) { # set-url
            $branch_name = 'origin';
        } else {
            $branch_name = shift;
        }
254 255 256 257 258 259
    } elsif ($command eq 'new' || $command eq 'fetch') {
        if (@_ < 1) {
            $branch_name = 'origin';
        } else {
            $branch_name = shift;
        }
260 261
    }

262 263 264
    push(@args, @_);
    print "args: @args\n";

Simon Marlow's avatar
Simon Marlow committed
265 266 267 268 269 270 271
    for $line (@packages) {

            $localpath  = $$line{"localpath"};
            $tag        = $$line{"tag"};
            $remotepath = $$line{"remotepath"};
            $scm        = $$line{"vcs"};
            $upstream   = $$line{"upstream"};
272 273 274 275 276 277

            # Check the SCM is OK as early as possible
            die "Unknown SCM: $scm" if (($scm ne "darcs") and ($scm ne "git"));

            # Work out the path for this package in the repo we pulled from
            if ($checked_out_tree) {
Simon Marlow's avatar
Simon Marlow committed
278
                $path = "$repo_base/$localpath";
279 280
            }
            else {
Simon Marlow's avatar
Simon Marlow committed
281
                $path = "$repo_base/$remotepath";
282
            }
Simon Marlow's avatar
Simon Marlow committed
283

284 285 286 287 288 289 290 291 292 293
            # Work out the arguments we should give to the SCM
            if ($command =~ /^(?:w|wh|wha|what|whats|whatsn|whatsne|whatsnew)$/) {
                @scm_args = (($scm eq "darcs" and "whatsnew")
                          or ($scm eq "git" and "status"));
                
                # Hack around 'darcs whatsnew' failing if there are no changes
                $ignore_failure = 1;
            }
            elsif ($command =~ /^(?:pus|push)$/) {
                @scm_args = "push";
Simon Marlow's avatar
Simon Marlow committed
294
                $want_remote_repo = 1;
295 296 297
            }
            elsif ($command =~ /^(?:pul|pull)$/) {
                @scm_args = "pull";
Simon Marlow's avatar
Simon Marlow committed
298
                $want_remote_repo = 1;
299 300 301 302 303 304 305 306 307 308 309 310 311 312
                # Q: should we append the -a argument for darcs repos?
            }
            elsif ($command =~ /^(?:g|ge|get)$/) {
                # Skip any repositories we have not included the tag for
                if (not defined($tags{$tag})) {
                    next;
                }
                
                if (-d $localpath) {
                    warning("$localpath already present; omitting") if $localpath ne ".";
                    next;
                }
                
                # The first time round the loop, default the get-mode
313
                if ($scm eq "darcs" && not defined($get_mode)) {
314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331
                    warning("adding --partial, to override use --complete");
                    $get_mode = "--partial";
                }
                
                # The only command that doesn't need a repo
                $local_repo_unnecessary = 1;
                
                if ($scm eq "darcs") {
                    # Note: we can only use the get-mode with darcs for now
                    @scm_args = ("get", $get_mode, $path, $localpath);
                }
                else {
                    @scm_args = ("clone", $path, $localpath);
                }
            }
            elsif ($command =~ /^(?:s|se|sen|send)$/) {
                @scm_args = (($scm eq "darcs" and "send")
                          or ($scm eq "git" and "send-email"));
Simon Marlow's avatar
Simon Marlow committed
332
                $want_remote_repo = 1;
333
            }
334
            elsif ($command =~ /^fetch$/) {
335
                @scm_args = ("fetch", "$branch_name");
336 337
            }
            elsif ($command =~ /^new$/) {
338
                @scm_args = ("log", "$branch_name..");
339
            }
340 341 342 343 344
            elsif ($command =~ /^remote$/) {
                if ($subcommand eq 'add') {
                    @scm_args = ("remote", "add", $branch_name, $path);
                } elsif ($subcommand eq 'rm') {
                    @scm_args = ("remote", "rm", $branch_name);
345 346
                } elsif ($subcommand eq 'set-url') {
                    @scm_args = ("remote", "set-url", $branch_name, $path);
347 348
                }
            }
349 350 351 352 353 354
            else {
                die "Unknown command: $command";
            }
            
            # Actually execute the command
            if (repoexists ($scm, $localpath)) {
Simon Marlow's avatar
Simon Marlow committed
355 356
                if ($want_remote_repo) {
                    if ($scm eq "darcs") {
357
                        scm (".", $scm, @scm_args, @args, "--repodir=$localpath", $path);
Simon Marlow's avatar
Simon Marlow committed
358 359
                    } else {
                        # git pull doesn't like to be used with --work-dir
Simon Marlow's avatar
Simon Marlow committed
360
                        # I couldn't find an alternative to chdir() here
361
                        scm ($localpath, $scm, @scm_args, @args, $path, "master");
Simon Marlow's avatar
Simon Marlow committed
362 363 364
                    }
                } else {
                    # git status *must* be used with --work-dir, if we don't chdir() to the dir
365
                    scm ($localpath, $scm, @scm_args, @args);
Simon Marlow's avatar
Simon Marlow committed
366
                }
367 368 369
            }
            elsif ($local_repo_unnecessary) {
                # Don't bother to change directory in this case
370
                scm (".", $scm, @scm_args, @args);
371 372 373 374 375 376 377 378 379 380
            }
            elsif ($tag eq "") {
                message "== Required repo $localpath is missing! Skipping";
            }
            else {
                message "== $localpath repo not present; skipping";
            }
    }
}

381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400

sub help()
{
        # Get the built in help
        my $help = <<END;
What do you want to do?
Supported commands:

 * whatsnew
 * push
 * pull
 * get, with options:
  * --<package-tag>
  * --complete
  * --partial
 * fetch
 * send
 * new
 * remote add <branch-name>
 * remote rm <branch-name>
401
 * remote set-url [--push] <branch-name>
402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427

Available package-tags are:
END

        # Collect all the tags in the packages file
        my %available_tags;
        open IN, "< packages" or die "Can't open packages file";
        while (<IN>) {
            chomp;
            if (/^([^# ]+) +(?:([^ ]+) +)?([^ ]+) +([^ ]+)/) {
                if (defined($2) && $2 ne "-") {
                    $available_tags{$2} = 1;
                }
            }
            elsif (! /^(#.*)?$/) {
                die "Bad line: $_";
            }
        }
        close IN;
        
        # Show those tags and the help text
        my @available_tags = keys %available_tags;
        print "$help@available_tags\n";
        exit 1;
}

428 429 430 431 432
sub main {
    if (! -d ".git" || ! -d "compiler") {
        die "error: sync-all must be run from the top level of the ghc tree."
    }

Simon Marlow's avatar
Simon Marlow committed
433 434 435
    $tags{"-"} = 1;
    $tags{"dph"} = 1;

436 437 438 439 440 441 442 443 444 445
    while ($#_ ne -1) {
        my $arg = shift;
        # We handle -q here as well as lower down as we need to skip over it
        # if it comes before the source-control command
        if ($arg eq "-q") {
            $verbose = 1;
        }
        elsif ($arg eq "-s") {
            $verbose = 0;
        }
Simon Marlow's avatar
Simon Marlow committed
446 447 448
        elsif ($arg eq "-r") {
            $defaultrepo = shift;
        }
449 450 451
        elsif ($arg eq "--ignore-failure") {
            $ignore_failure = 1;
        }
452 453 454
        elsif ($arg eq "--complete" || $arg eq "--partial") {
            $get_mode = $arg;
        }
Simon Marlow's avatar
Simon Marlow committed
455 456 457 458 459
        # Use --checked-out if the remote repos are a checked-out tree,
        # rather than the master trees.
        elsif ($arg eq "--checked-out") {
            $checked_out_flag = 1;
        }
460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475
        # --<tag> says we grab the libs tagged 'tag' with
        # 'get'. It has no effect on the other commands.
        elsif ($arg =~ m/^--/) {
            $arg =~ s/^--//;
            $tags{$arg} = 1;
        }
        else {
            unshift @_, $arg;
            if (grep /^-q$/, @_) {
                $verbose = 1;
            }
            last;
        }
    }

    if ($#_ eq -1) {
476
        help();
477 478 479 480 481 482 483 484 485
    }
    else {
        # Give the command and rest of the arguments to the main loop
        scmall @_;
    }
}

main(@ARGV);