libArchive.pm.in 32.8 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
#!/usr/bin/perl -wT
#
# EMULAB-COPYRIGHT
# Copyright (c) 2005 University of Utah and the Flux Group.
# All rights reserved.
#
# XXX Need to deal with locking at some point ...
#
package libArchive;

use strict;
use Exporter;
use vars qw(@ISA @EXPORT);

@ISA    = "Exporter";
@EXPORT = qw ( );

# Must come after package declaration!
use lib '@prefix@/lib';
use libdb;
21
use libtestbed;
22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39
use English;
use File::stat;
use File::Basename;
use POSIX qw(strftime);
use Time::HiRes qw(gettimeofday);

# Configure variables
my $TB		= "@prefix@";
# XXX
my $ARCHIVEDIR  = "/usr/testbed/exparchive";
my $TESTMODE    = @TESTMODE@;
my $TBOPS       = "@TBOPSEMAIL@";
my $ELABINELAB  = @ELABINELAB@;
my $MD5		= "/sbin/md5";
my $MKDIR       = "/bin/mkdir";
my $CHMOD       = "/bin/chmod";
my $TAR		= "/usr/bin/tar";
my $RM		= "/bin/rm";
40 41 42
my $SVN         = "/usr/local/bin/svn";
my $SVNADMIN    = "/usr/local/bin/svnadmin";
my $IMPORTER    = "$TB/sbin/svn_load_dirs.pl";
43
my $inittag     = 'root';
44
my $defaultview = 'head';
45
my $debug       = 1;
46
my $svnopt      = ($debug ? "" : "-q");
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61

# Little helper and debug function.
sub mysystem($)
{
    my ($command) = @_;

    print STDERR "Running '$command'\n"
	if ($debug);
    system($command);
}

#
# Create a new archive. Returns -1 if any error. Otherwise return
# the new record index.
# 
62
sub ArchiveCreate(;$$)
63
{
64
    my ($tag, $view) = @_;
65
    
66 67
    my $idx;
    my $dir;
68 69 70

    $tag = $inittag
	if (!defined($tag));
71 72
    $view = $defaultview
	if (!defined($view));
73

74
    # Tags cannot must start with a letter.
75 76 77
    if ($tag =~ /^\d+/) {
	$tag = "T" . $tag;
    }
78 79 80 81 82 83

    #
    # Need to create the directory for it, once we have the index.
    # 
    my $query_result =
	DBQueryWarn("insert into file_archives set ".
84
		    "  idx=NULL, ".
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103
		    "  date_created=UNIX_TIMESTAMP(now())");

    return -1
	if (!$query_result);

    $idx = $query_result->insertid;
    $dir = "$ARCHIVEDIR/$idx";

    #
    # Create the directory and store the absolute path into the new record.
    # This should probably be a privledged operation at some point.
    # 
    mysystem("$MKDIR $dir") == 0 or goto bad;
    mysystem("$CHMOD 775 $dir") == 0 or goto bad;

    DBQueryWarn("update file_archives set directory='$dir' where idx='$idx'")
	or goto bad;

    #
104
    # Make subdirs. One to hold the control tree, and the other
105 106
    # to hold currently checked out versions of the tree. Lastly, we
    # need a place to copyin files before they are added to the repo.
107
    #
108
    my $repodir   = "$dir/repo";
109 110
    my $checkouts = "$dir/checkouts";
    my $checkins  = "$dir/checkins";
111

112 113
    if (! mkdir("$repodir", 0777)) {
	print STDERR "ArchiveCreate: Could not mkdir $repodir: $!\n";
114 115
	goto bad;
    }
116 117
    if (! chmod(0777, "$repodir")) {
	print STDERR "ArchiveCreate: Could not chmod $repodir: $!\n";
118 119
	goto bad;
    }
120 121
    if (! mkdir("$checkouts", 0777)) {
	print STDERR "ArchiveCreate: Could not mkdir $checkouts: $!\n";
122 123
	goto bad;
    }
124 125
    if (! chmod(0777, "$checkouts")) {
	print STDERR "ArchiveCreate: Could not chmod $checkouts: $!\n";
126 127
	goto bad;
    }
128 129
    if (! mkdir("$checkins", 0777)) {
	print STDERR "ArchiveCreate: Could not mkdir $checkins: $!\n";
130 131
	goto bad;
    }
132 133 134 135 136 137 138 139 140 141
    if (! chmod(0777, "$checkins")) {
	print STDERR "ArchiveCreate: Could not chmod $checkins: $!\n";
	goto bad;
    }
    if (! mkdir("$checkins/$view", 0777)) {
	print STDERR "ArchiveCreate: Could not mkdir $checkins/$view: $!\n";
	goto bad;
    }
    if (! chmod(0777, "$checkins/$view")) {
	print STDERR "ArchiveCreate: Could not chmod $checkins/$view: $!\n";
142 143
	goto bad;
    }
144 145
    # Initialize the repo.
    mysystem("$SVNADMIN create $repodir") == 0
146
	or goto bad;
147 148 149 150 151 152 153 154 155 156 157
    
    # Create an stub directory tree and import it as "root"
    mysystem("cd $dir; mkdir ignore; cd ignore; mkdir $view; ".
             "         mkdir $view/trunk $view/savepoint $view/tags; ".
	     "$SVN import -m 'ArchiveCreate' $view file://$repodir/$view")
	== 0 or goto bad;

    # Create a branch tag in the tags directory to base differences against.
    mysystem("$SVN copy -m 'ArchiveCreate Branch' ".
	     "          file://$repodir/$view/trunk ".
	     "          file://$repodir/$view/tags/${tag}-branch")
158
	== 0 or goto bad;
159
    
160 161
    # Now check it out. This creates the $checkouts/$view directory.
    mysystem("cd $checkouts; ".
162
	     "$SVN checkout $svnopt file://$repodir/$view")
163 164
	== 0 or goto bad;

165 166 167 168 169
    # Now enter the default view (okay, branch) of this archive.
    DBQueryWarn("insert into archive_views set ".
		"  current_tag='$tag', archive_idx='$idx', view='$view', ".
		"  date_created=UNIX_TIMESTAMP(now())") or goto bad;
    
170
    # Now enter an initial tag for the tree. Nothing actually gets tagged.
171
    DBQueryWarn("insert into archive_tags set idx=NULL, ".
172
		"  tag='$tag', archive_idx='$idx', ".
173 174 175 176 177 178 179
		"  date_created=UNIX_TIMESTAMP(now())") or goto bad;
    
    return $idx;

  bad:
#    mysystem("$RM -rf $dir")
#        if (defined($dir));
180 181 182
    DBQueryFatal("delete from archive_views ".
		 "where view='$view' and archive_idx='$idx'")
	if (defined($idx));
183 184 185 186 187 188 189 190 191 192 193
    DBQueryFatal("delete from file_archives where idx='$idx'")
	if (defined($idx));
    return -1;
}

#
# Add a file to an archive. Returns -1 if any error. Otherwise return 0.
# All this does is copy the file (and its directory structure) into the
# temporary store. Later, after all the files are in the tree, must
# commit it to the repo. 
#
194
sub ArchiveAdd($$;$)
195
{
196 197 198 199
    my ($archive_idx, $pathname, $view) = @_;

    $view = $defaultview
	if (!defined($view));
200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254

    if (! -e $pathname || ! -r $pathname) {
	print STDERR "ArchiveFile: $pathname cannot be read!\n";
	return -1;
    }

    if (! -f $pathname) {
	print STDERR "ArchiveFile: $pathname must be a plain file!\n";
	return -1;
    }
    #
    # Check that the path does not contain an links to files outside
    # the directory space the user is allowed to access.
    #
    my $realpath = `realpath $pathname`;
    if ($realpath =~ /^([-\w\/\.\+\@,]+)$/) {
	$realpath = $1;
    }
    else {
	print STDERR "ArchiveFile: ".
	    "Bad data returned by realpath: $realpath\n";
    }
    #
    # The file must reside in /proj, /groups, or /users. 
    #
    if (! ($realpath =~ /^\/proj/) &&
	! ($realpath =~ /^\/groups/) &&
	! ($realpath =~ /^\/users/)) {
	print STDERR "ArchiveFile: ".
	    "$realpath does not resolve to an allowed directory!\n";
	return -1;
    }
    
    # Strip leading / from the pathname, and taint check it. 
    if ($pathname =~ /^[\/]+([-\w\/\.\+\@,]+)$/) {
	$pathname = $1;
    }
    else {
	print STDERR "ArchiveFile: Illegal characters in pathname $pathname\n";
	return -1;
    }

    #
    # See if the archive exists and if it does, get the pathname to it.
    #
    my $directory;
    if (GetArchiveDirectory($archive_idx, \$directory) < 0) {
	print STDERR "ArchiveFile: ".
	    "Archive '$archive_idx' does not exist in the DB!\n";
	return -1;
    }
    if (! -d $directory || ! -w $directory) {
	print STDERR "ArchiveFile: $directory cannot be written!\n";
	return -1;
    }
255
    my $repodir   = "$directory/repo";
256 257
    my $checkout  = "$directory/checkouts/$view";
    my $checkin   = "$directory/checkins/$view";
258 259 260 261 262
    
    #
    # See if the file is already in the archive. We currently deal with
    # just files; directories are gonna be a pain in the butt.
    #
263
    my $target_path = "$checkin/$pathname";
264 265 266 267 268 269

    #
    # The file should not already exist in the temporary store. 
    #
    if (-e $target_path) {
	print STDERR "ArchiveFile: ".
270
	    "WARNING: $pathname already exists in archive '$archive_idx'!\n";
271 272 273 274 275 276
    }

    #
    # Not in the archive. Copy the file in. We use tar cause we
    # want to retain the directory structure and mode bits, etc.
    #
277
    mysystem("$TAR cf - -C / $pathname | tar xf - -C $checkin");
278 279 280 281 282 283 284 285
    if ($?) {
	print STDERR "ArchiveFile: Could not copy in /$pathname\n";
	return -1;
    }
    return 0;
}

#
286 287 288 289 290
# Bring the current contents of the temporary store into the archive as a
# checkpoint (or a savepoint I guess). Implementationlly, its really a
# branch off the current import revision, since it does not become a new
# head revision until the entire branch (all the savepoints) is committed
# later, say when the experiment is swapped out.
291
#
292
sub ArchiveSavePoint($;$$)
293
{
294 295 296 297 298 299 300 301 302
    my ($archive_idx, $savetag, $view) = @_;
    my $cwd;

    $view = $defaultview
	if (!defined($view));

    return -1
	if (TBScriptLock("archive_${archive_idx}", 0, 120) !=
	    TBSCRIPTLOCK_OKAY());
303 304 305 306 307 308

    #
    # See if the archive exists and if it does, get the pathname to it.
    #
    my $directory;
    if (GetArchiveDirectory($archive_idx, \$directory) < 0) {
309
	print STDERR "ArchiveSavePoint: ".
310
	    "Archive '$archive_idx' does not exist in the DB!\n";
311
	goto bad;
312 313
    }
    if (! -d $directory || ! -w $directory) {
314
	print STDERR "ArchiveSavePoint: $directory cannot be written!\n";
315
	goto bad;
316
    }
317
    my $repodir   = "$directory/repo";
318 319
    my $checkout  = "$directory/checkouts/$view";
    my $checkin   = "$directory/checkins/$view";
320 321 322 323 324 325

    # Need to remember where we came from!
    chomp($cwd = `pwd`);
    # Must do the taint check too.
    if ($cwd =~ /^([-\w\.\/]+)$/) {
	$cwd = $1;
326
    }
327 328
    else {
	print STDERR "ArchiveSavePoint: Bad data in $cwd!\n";
329
	goto bad;
330 331
    }

332
    # Get the current tag for the archive.
333 334
    my ($archive_tag);
    if (GetArchiveCurrentTags($archive_idx, $view, \$archive_tag) < 0) {
335 336 337 338 339 340 341 342 343 344 345 346 347 348
	print STDERR "ArchiveSavePoint: ".
	    "Archive '$archive_idx' does not have a current tag!\n";
	goto bad;
    }

    # Make up a savetag if one not provided.
    if (!defined($savetag)) {
	my ($seconds, $microseconds) = gettimeofday();
	
	$savetag  = POSIX::strftime("T20%y%m%d-%H%M%S-", localtime());
	$savetag .= $microseconds;
	$savetag .= "_savepoint";
    }

349
    # Tags must start with a letter.
350 351 352 353
    if ($savetag =~ /^\d+/) {
	$savetag = "T" . $savetag;
    }
    
354
    #
355
    # Use svn import command. This is nice cause it handles all the
356 357 358
    # subdirs and stuff in one shot, instead of trying to deal with
    # each file and directory individually.
    #
359 360 361 362
    if (! chdir("$checkin")) {
	print STDERR "ArchiveSavePoint: Cannot chdir to $checkin!\n";
	goto bad;
    }
363 364 365 366 367 368 369 370 371 372 373 374
    mysystem("$IMPORTER -no_user_input file://$repodir ".
	     "          $view/savepoint . > /dev/null")
	== 0 or goto bad;

    #
    # Create the tag for this savepoint. 
    # 
    mysystem("$SVN copy -m 'ArchiveCreate Branch' ".
	     "          file://$repodir/$view/savepoint ".
	     "          file://$repodir/$view/tags/${savetag}")
	== 0 or goto bad;
    
375 376 377 378

    #
    # And record the new tag. 
    # 
379
    DBQueryWarn("insert into archive_tags set idx=NULL, ".
380
		"  tag='$savetag', ".
381
		"  archive_idx='$archive_idx', ".
382
		"  date_created=UNIX_TIMESTAMP(now())") or goto bad;
383

384
  okay:
385 386 387
    TBScriptUnlock();
    chdir($cwd)
	if (defined($cwd));
388 389 390
    return 0;

  bad:
391 392 393
    TBScriptUnlock();
    chdir($cwd)
	if (defined($cwd));
394 395 396 397 398 399 400
    return -1;
}

#
# Commit the current contents of the temporary store to the archive.
# Returns -1 if any error. Otherwise return 0.
#
401
sub ArchiveCommit($;$$$)
402
{
403
    my ($archive_idx, $newtag, $view, $altdir) = @_;
404
    my $noactivity = 0;
405 406 407 408 409 410 411 412
    my $cwd;

    $view = $defaultview
	if (!defined($view));

    return -1
	if (TBScriptLock("archive_${archive_idx}", 0, 120) !=
	    TBSCRIPTLOCK_OKAY());
413 414 415 416 417 418 419 420

    #
    # See if the archive exists and if it does, get the pathname to it.
    #
    my $directory;
    if (GetArchiveDirectory($archive_idx, \$directory) < 0) {
	print STDERR "ArchiveCommit: ".
	    "Archive '$archive_idx' does not exist in the DB!\n";
421
	goto bad;
422 423 424
    }
    if (! -d $directory || ! -w $directory) {
	print STDERR "ArchiveCommit: $directory cannot be written!\n";
425
	goto bad;
426
    }
427
    my $repodir   = "$directory/repo";
428 429
    my $checkout  = "$directory/checkouts/$view";
    my $checkin   = (defined($altdir) ? $altdir : "$directory/checkins/$view");
430 431 432 433 434 435 436 437 438

    # Need to remember where we came from!
    chomp($cwd = `pwd`);
    # Must do the taint check too.
    if ($cwd =~ /^([-\w\.\/]+)$/) {
	$cwd = $1;
    }
    else {
	print STDERR "ArchiveSavePoint: Bad data in $cwd!\n";
439
	goto bad;
440 441
    }

442 443 444
    if (! chdir("$checkin")) {
	print STDERR "ArchiveCommit: Cannot chdir to $checkin!\n";
	goto bad;
445 446 447
    }

    # Get the current tags for the archive.
448
    my ($archive_tag, $previous_tag);
449
    if (GetArchiveCurrentTags($archive_idx, $view, \$archive_tag,
450
			      \$previous_tag) < 0) {
451 452 453 454 455 456
	print STDERR "ArchiveCommit: ".
	    "Archive '$archive_idx' does not have a current tag!\n";
	goto bad;
    }

    #
457 458
    # Form new tag.
    # 
459 460 461
    my ($seconds, $microseconds) = gettimeofday();
    my $import_tag  = POSIX::strftime("T20%y%m%d-%H%M%S-", localtime());
    $import_tag    .= $microseconds;
462 463

    if (!defined($newtag)) {
464
	$newtag = $import_tag . "_commit";
465 466
    }

467
    # Tags cannot must start with a letter.
468 469 470
    if ($newtag =~ /^\d+/) {
	$newtag = "T" . $newtag;
    }
471

472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489
    #
    # Lets see if there has been any action since the last commit.
    # Check for new tags, and if nothing has happened, just drop a
    # new set of tags in and return.
    #
    my $query_result =
	DBQueryWarn("select tag from archive_tags ".
		    "where archive_idx='$archive_idx' ".
		    "order by idx desc limit 1");
    goto bad
	if (!$query_result || !$query_result->numrows);
    
    my ($tmptag) = $query_result->fetchrow_array();
    if ($tmptag eq $archive_tag) {
	print "ArchiveCommit: Archive is clean; no need to commit.\n";
	$noactivity = 1;
    }
    
490
    # Clean the temp dir for next phase.
491
    mysystem("/bin/rm -rf $checkin/*");
492
    if ($?) {
493
	print STDERR "ArchiveCommit: Could not clean $checkin!\n";
494
	goto bad;
495 496 497
    }

    #
498 499 500
    # Okay, do the commit to the trunk for this view.
    # 
    if (! $noactivity) {
501
	#
502
	# Check out the current trunk.
503
	#
504 505 506
	mysystem("$SVN checkout $svnopt file://$repodir/$view/trunk")
	    == 0 or goto bad;

507
	#
508 509 510 511 512 513 514 515 516 517
	# Do a merge from the branch off the previous commit tag, with
	# the savepoint. This is merged into the working directory we
	# just checked out above. This will do the work of scheduling
	# additions and deletions.
	#
	mysystem("$SVN merge $svnopt ".
		 "     file://$repodir/$view/tags/${archive_tag}-branch ".
		 "     file://$repodir/$view/savepoint ".
		 "     trunk")
	    == 0 or goto bad;
518

519 520 521 522 523 524
	#
	# Now commit to the trunk!
	#
	mysystem("$SVN commit $svnopt ".
		 "     -m 'Commit merge of ${archive_tag} to trunk' trunk")
	    == 0 or goto bad;
525
    }
526

527 528 529 530 531 532 533 534 535 536 537 538
    # Create a tag in the tags directory for the commit.
    mysystem("$SVN copy -m 'ArchiveCommit' ".
	     "          file://$repodir/$view/trunk ".
	     "          file://$repodir/$view/tags/${newtag}")
	== 0 or goto bad;
    
    # Create a branch tag in the tags directory to base differences against.
    mysystem("$SVN copy -m 'ArchiveCommit Branch' ".
	     "          file://$repodir/$view/trunk ".
	     "          file://$repodir/$view/tags/${newtag}-branch")
	== 0 or goto bad;
    
539
    DBQueryWarn("insert into archive_tags set idx=NULL, ".
540
		"  tag='$newtag', ".
541
		"  archive_idx='$archive_idx', ".
542 543
		"  date_created=UNIX_TIMESTAMP(now())")
	or goto bad;
544

545
    DBQueryWarn("update archive_views set ".
546
		"  current_tag='$newtag', ".
547
		"  previous_tag='$archive_tag' ".
548 549
		"where archive_idx='$archive_idx' and view='$view'")
	or goto bad;
550 551

    # Clean the temp dir for later.
552
    mysystem("/bin/rm -rf $checkin/*");
553
    if ($?) {
554
	print STDERR "ArchiveCommit: Could not clean $checkin!\n";
555
	goto bad;
556 557
    }

558 559 560
    # And now into the checkout dir to checkout a current copy.
    if (! chdir("$checkout")) {
	print STDERR "ArchiveCommit: Cannot chdir to $checkout!\n";
561
	goto bad;
562
    }
563
    mysystem("$SVN $svnopt update trunk");
564
    if ($?) {
565
	print STDERR "ArchiveCommit: Could not update head revision!\n";
566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585
	goto bad;
    }
  okay:
    TBScriptUnlock();
    chdir($cwd)
	if (defined($cwd));
    return 0;

  bad:
    TBScriptUnlock();
    chdir($cwd)
	if (defined($cwd));
    return -1;
}

#
# Fork an archive (okay, branch) for use in separate development. Note that
# once forked, there is no join, as that would be impossibly hard to deal
# with cause of conflicts.
#
586
sub ArchiveFork($$;$$$)
587
{
588 589
    my ($archive_idx, $newview, $branchtag, $newtag, $view) = @_;
    my $sourcepoint;
590 591 592 593 594 595 596 597 598 599 600 601 602 603
    my $cwd;

    $view = $defaultview
	if (!defined($view));

    return -1
	if (TBScriptLock("archive_${archive_idx}", 0, 120) !=
	    TBSCRIPTLOCK_OKAY());

    #
    # See if the archive exists and if it does, get the pathname to it.
    #
    my $directory;
    if (GetArchiveDirectory($archive_idx, \$directory) < 0) {
604
	print STDERR "ArchiveCommit: ".
605 606 607 608 609
	    "Archive '$archive_idx' does not exist in the DB!\n";
	goto bad;
    }
    if (! -d $directory || ! -w $directory) {
	print STDERR "ArchiveCommit: $directory cannot be written!\n";
610
	goto bad;
611
    }
612
    my $repodir     = "$directory/repo";
613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630
    my $checkouts   = "$directory/checkouts";
    my $checkout    = "$directory/checkouts/$view";
    my $checkin     = "$directory/checkins/$view";
    my $newcheckout = "$directory/checkouts/$newview";
    my $newcheckin  = "$directory/checkins/$newview";

    # Need to remember where we came from!
    chomp($cwd = `pwd`);
    # Must do the taint check too.
    if ($cwd =~ /^([-\w\.\/]+)$/) {
	$cwd = $1;
    }
    else {
	print STDERR "ArchiveSavePoint: Bad data in $cwd!\n";
	goto bad;
    }

    # Get the current tags for the archive.
631
    my ($archive_tag, $previous_tag);
632
    if (GetArchiveCurrentTags($archive_idx, $view, \$archive_tag,
633
			      \$previous_tag) < 0) {
634 635 636 637 638
	print STDERR "ArchiveCommit: ".
	    "Archive '$archive_idx' does not have a current tag!\n";
	goto bad;
    }

639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654
    #
    # Form new tag.
    # 
    my ($seconds, $microseconds) = gettimeofday();
    my $import_tag  = POSIX::strftime("T20%y%m%d-%H%M%S-", localtime());
    $import_tag    .= $microseconds;

    if (!defined($newtag)) {
	$newtag = $import_tag . "_fork";
    }

    # Tags cannot must start with a letter.
    if ($newtag =~ /^\d+/) {
	$newtag = "T" . $newtag;
    }

655 656 657 658 659 660 661 662 663
    # Create new view directories and checkout.
    if (! mkdir("$newcheckin", 0777)) {
	print STDERR "ArchiveCreate: Could not mkdir $newcheckin: $!\n";
	goto bad;
    }
    if (! chmod(0777, "$newcheckin")) {
	print STDERR "ArchiveCreate: Could not chmod $newcheckin: $!\n";
	goto bad;
    }
664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690

    # Create newview directory in the repo.
    mysystem("$SVN mkdir -m 'ArchiveFork' ".
	     "          file://$repodir/$newview")
	== 0 or goto bad;

    # Split at the trunk if no branchpoint provided.
    if (defined($branchtag)) {
	$sourcepoint = "tags/$branchtag";
    }
    else {
	$sourcepoint = "trunk"
    }

    # Copy the trunk of the old view.
    mysystem("$SVN copy $svnopt -m 'ArchiveFork' ".
	     "          file://$repodir/$view/$sourcepoint ".
	     "          file://$repodir/$newview/trunk")
	== 0 or goto bad;

    # Do not want to copy the tags/savepoints directories. Add new ones.
    mysystem("$SVN mkdir -m 'ArchiveFork' ".
	     "          file://$repodir/$newview/savepoint ".
	     "          file://$repodir/$newview/tags")
	== 0 or goto bad;

    # Now check it out. This creates the checkouts/$newview directory.
691
    mysystem("cd $checkouts; ".
692
	     "$SVN checkout $svnopt file://$repodir/$newview")
693 694
	== 0 or goto bad;

695 696 697 698 699
    # Now enter the newview (okay, branch) of this archive.
    DBQueryWarn("insert into archive_views set ".
		"  current_tag='$newtag', archive_idx='$archive_idx', ".
		"  view='$newview', ".
		"  date_created=UNIX_TIMESTAMP(now())") or goto bad;
700
    
701 702 703 704
    # Now enter an initial tag for the new view. Nothing actually gets tagged.
    DBQueryWarn("insert into archive_tags set idx=NULL, ".
		"  tag='$newtag', archive_idx='$archive_idx', ".
		"  date_created=UNIX_TIMESTAMP(now())") or goto bad;
705

706
  okay:
707 708 709
    TBScriptUnlock();
    chdir($cwd)
	if (defined($cwd));
710
    return 0;
711 712

  bad:
713 714 715
    TBScriptUnlock();
    chdir($cwd)
	if (defined($cwd));
716
    return -1;
717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741
}

#
# Archive the Archive, moving it into the expinfo directory.
# I intend this to be run only when an experiment is terminated.
# No need to have two copies.
#
sub ArchiveArchive($$)
{
    my ($archive_idx, $dirpath) = @_;
    my $target = "$dirpath/Archive";

    #
    # See if the archive exists and if it does, get the pathname to it.
    #
    my $directory;
    if (GetArchiveDirectory($archive_idx, \$directory) < 0) {
	print STDERR "ArchiveCommit: ".
	    "Archive '$archive_idx' does not exist in the DB!\n";
	return -1;
    }
    if (! -d $directory || ! -w $directory) {
	print STDERR "ArchiveFile: $directory cannot be written!\n";
	return -1;
    }
742
    my $repodir  = "$directory/repo";
743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758

    if (! -e $target) {
	if (! mkdir("$target", 0777)) {
	    print STDERR "ArchiveArchive: Could not mkdir $target: $!\n";
	    return -1;
	}
	if (! chmod(0777, "$target")) {
	    print STDERR "ArchiveArchive: ".
		"Could not chmod directory $target: $!\n";
	    return -1;
	}
    }    

    #
    # Tar up the whole thing and move it across.
    #
759
    mysystem("$TAR cf - -C $repodir . | tar xf - -C $target");
760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797
    if ($?) {
	print STDERR "ArchiveArchive: Could not copy in $directory\n";
	return -1;
    }
    return 0;
}

#
# Destroy an archive. The DB state is retained unless optional flag says
# to clean it.
#
sub ArchiveDestroy($;$)
{
    my ($archive_idx, $clean) = @_;

    #
    # See if the archive exists and if it does, get the pathname to it.
    #
    my $directory;
    if (GetArchiveDirectory($archive_idx, \$directory) < 0) {
	print STDERR "ArchiveDestroy: ".
	    "Archive '$archive_idx' does not exist in the DB!\n";
	return -1;
    }
    if (! -d $directory || ! -w $directory) {
	print STDERR "ArchiveDestroy: $directory does not exist!\n";
	return 0;
    }

    mysystem("/bin/rm -rf $directory");
    if ($?) {
	print STDERR "ArchiveDestroy: ".
	    "Could not remove contents of $directory!\n";
	return -1;
    }
    if (defined($clean) && $clean) {
	(DBQueryWarn("delete from archive_tags ".
		     "where archive_idx='$archive_idx'") &&
798 799
	 DBQueryWarn("delete from archive_views ".
		     "where archive_idx='$archive_idx'") &&
800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829
	 DBQueryWarn("delete from file_archives ".
		     "where idx='$archive_idx'")) || return -1;
    }
    return 0;
}

#
# Get the directory for an archive, given its index. Returns -1 on error,
# zero otherwise. 
#
sub GetArchiveDirectory($$)
{
    my ($idx, $rvalp) = @_;
    
    my $query_result =
	DBQueryWarn("select directory from file_archives where idx='$idx'");

    return -1
	if (!$query_result || !$query_result->numrows);
    my ($dir) = $query_result->fetchrow_array();

    $$rvalp = $dir
	if (defined($rvalp));
    return 0;
}

#
# Get the current tag for an archive, given its index. Returns -1 on error,
# zero otherwise. Place tag in the return pointer.
#
830
sub GetArchiveCurrentTags($$$;$)
831
{
832
    my ($archive_idx, $view, $tagp, $prevp) = @_;
833 834
    
    my $query_result =
835
	DBQueryWarn("select v.current_tag,v.previous_tag ".
836 837 838 839 840 841
		    "    from archive_views as v ".
		    "left join archive_tags as t on ".
		    "     t.archive_idx=v.archive_idx and ".
		    "     t.tag=v.current_tag ".
		    "where v.archive_idx='$archive_idx' and ".
		    "      v.view='$view'");
842 843 844

    return -1
	if (!$query_result);
845
    my ($tag,$previous) = $query_result->fetchrow_array();
846
    
847 848 849 850
    $$tagp = $tag
	if (defined($tagp));
    $$prevp = $previous
	if (defined($prevp));
851 852 853 854 855 856 857 858
    return 0;
}

#
# Get the archive index for an experiment. The index is kept in the historical
# experiment_stats table, not the current experiments table. That is cause
# we keep the archive and its DB info around forever with the stats.
#
859
sub TBExperimentArchiveInfo($$$$)
860
{
861
    my ($pid, $eid, $idxp, $viewp) = @_;
862 863

    my $query_result =
864
	DBQueryWarn("select s.archive_idx,e.idx from experiments as e ".
865 866 867 868 869 870
		    "left join experiment_stats as s on s.exptidx=e.idx ".
		    "where e.pid='$pid' and e.eid='$eid'");

    return -1
	if (!$query_result || $query_result->numrows == 0);

871
    my ($archive_idx,$exptidx) = $query_result->fetchrow_array();
872 873

    return -1
874 875 876 877 878 879
	if (!defined($archive_idx));

    $$idxp = $archive_idx
	if (defined($idxp));
    $$viewp = "$exptidx"
	if (defined($viewp));
880
    
881
    return 0;
882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904
}

#
# Create a new archive for an experiment. This has to update the
# experiment_stats table with the newly created archive index.
# Then we have to set the current tag for the experiment in the
# resources table for the experiment.
# Returns zero on success, -1 on failure.
#
sub TBCreateExperimentArchive($$)
{
    my ($pid, $eid) = @_;

    # Grab experiment indicies we need,
    my $query_result =
	DBQueryWarn("select e.idx,s.rsrcidx from experiments as e ".
		    "left join experiment_stats as s on e.idx=s.exptidx ".
		    "where e.pid='$pid' and e.eid='$eid'");
    if (!$query_result || !$query_result->numrows) {
	return -1;
    }

    my ($exptidx,$rsrcidx) = $query_result->fetchrow_array();
905 906 907 908 909
    my $archive_tag = "T${rsrcidx}";

    #
    # Create the new archive and get back the new index. 
    #
910
    my $archive_idx = ArchiveCreate($archive_tag, "$exptidx");
911 912
    return -1
	if ($archive_idx < 0);
913 914 915 916 917 918

    if (! (DBQueryWarn("update experiment_stats set ".
		       "      archive_idx='$archive_idx' ".
		       "where pid='$pid' and eid='$eid' and ".
		       "      exptidx='$exptidx'") &&
	   DBQueryWarn("update experiment_resources set ".
919
		       "      archive_tag='$archive_tag' ".
920 921 922 923 924 925 926 927 928 929 930 931 932
		       "where idx='$rsrcidx'"))) {
	ArchiveDestroy($archive_idx, 1);
	return -1;
    }
    return 0;
}

#
# Add a file to an experiment archive.
#
sub TBExperimentArchiveAddFile($$$)
{
    my ($pid, $eid, $pathname) = @_;
933
    my ($archive_idx, $view);
934 935

    return -1
936
	if (TBExperimentArchiveInfo($pid, $eid, \$archive_idx, \$view) < 0);
937

938
    return ArchiveAdd($archive_idx, $pathname, $view);
939 940 941
}

#
942
# SavePoint an experiment archive. 
943
#
944 945 946
sub TBExperimentArchiveSavePoint($$$)
{
    my ($pid, $eid, $tagext) = @_;
947
    my ($archive_idx, $view);
948 949

    return -1
950
	if (TBExperimentArchiveInfo($pid, $eid, \$archive_idx, \$view) < 0);
951 952

    #
953
    # Derive a tag that contains some useful info?
954 955 956 957 958 959
    #
    my ($seconds, $microseconds) = gettimeofday();
    my $newtag  = POSIX::strftime("T20%y%m%d-%H%M%S-", localtime());
    $newtag .= int($microseconds / 1000);
    $newtag .= "_${tagext}";

960
    return ArchiveSavePoint($archive_idx, $newtag, $view);
961 962 963 964 965 966 967 968
}

#
# Setup for a swapmod. A pain in the butt!
#
sub TBExperimentArchivePreSwapMod($$)
{
    my ($pid, $eid) = @_;
969
    my ($archive_idx, $view);
970 971

    return -1
972
	if (TBExperimentArchiveInfo($pid, $eid, \$archive_idx, \$view) < 0);
973 974 975 976 977 978 979 980 981 982 983

    my $directory;
    if (GetArchiveDirectory($archive_idx, \$directory) < 0) {
	print STDERR "ArchivePreSwapMod: ".
	    "Archive '$archive_idx' does not exist in the DB!\n";
	return -1;
    }
    if (! -d $directory || ! -w $directory) {
	print STDERR "ArchivePreSwapMod: $directory cannot be written!\n";
	return -1;
    }
984 985
    my $checkin    = "$directory/checkins/$view";
    my $preswapdir = "${checkin}.preswap";
986 987

    #
988
    # Derive a tag that says something useful?
989 990 991 992 993 994 995 996 997 998
    #
    my ($seconds, $microseconds) = gettimeofday();
    my $newtag  = POSIX::strftime("T20%y%m%d-%H%M%S-", localtime());
    $newtag .= int($microseconds / 1000);
    $newtag .= "_preswapmod";

    #
    # Do a savepoint just for grins,
    #
    return -1
999
	if (ArchiveSavePoint($archive_idx, $newtag, $view) != 0);
1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022

    #
    # Make a copy of the current tree, since its easier to rollback
    # if I just wait before doing a commit (until swapmod really finishes).
    #
    if (-e $preswapdir) {
	system("/bin/rm -rf $preswapdir");
	if (-e $preswapdir) {
	    print STDERR
		"ArchivePreSwapMod: Could not delete old preswap dir!\n";
	    return -1;
	}
    }
    if (! mkdir("$preswapdir", 0777)) {
	print STDERR "ArchivePreSwapMod: Could not mkdir $preswapdir: $!\n";
	return -1;
    }
    if (! chmod(0777, "$preswapdir")) {
	print STDERR "ArchivePreSwapMod: ".
	    "Could not chmod directory $preswapdir: $!\n";
	goto bad;
    }
    
1023
    mysystem("$TAR cf - -C $checkin . | tar xf - -C $preswapdir");
1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047
    if ($?) {
	print STDERR "ArchivePreSwapMod: Could not copy to $preswapdir\n";
	goto bad;
    }
    return 0;

  bad:
    # Be sure to remove the new directory!
    if (-e $preswapdir) {
	system("/bin/rm -rf $preswapdir");
	if (-e $preswapdir) {
	    print STDERR
		"ArchivePreSwapMod: Could not delete new preswap dir!\n";
	}
    }
    return -1;
}

#
# Rollback from a failed swapmod.
#
sub TBExperimentArchiveRollBack($$)
{
    my ($pid, $eid) = @_;
1048
    my ($archive_idx, $view);
1049 1050

    return -1
1051
	if (TBExperimentArchiveInfo($pid, $eid, \$archive_idx, \$view) < 0);
1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062

    my $directory;
    if (GetArchiveDirectory($archive_idx, \$directory) < 0) {
	print STDERR "ArchiveRollBack: ".
	    "Archive '$archive_idx' does not exist in the DB!\n";
	return -1;
    }
    if (! -d $directory || ! -w $directory) {
	print STDERR "ArchiveRollBack: $directory cannot be written!\n";
	return -1;
    }
1063 1064
    my $checkin    = "$directory/checkins/$view";
    my $preswapdir = "${checkin}.preswap";
1065 1066 1067 1068 1069 1070 1071 1072

    # In case we bailed out really early in the swapmod path.
    return 0
	if (! -e $preswapdir);

    #
    # Restore the old (preswap) tree to the current tree.
    #
1073 1074 1075
    if (-e $checkin) {
	system("/bin/rm -rf $checkin");
	if (-e $checkin) {
1076 1077 1078 1079 1080
	    print STDERR
		"ArchiveRollBack: Could not delete old preswap dir!\n";
	    return -1;
	}
    }
1081
    system("/bin/mv -f $preswapdir $checkin");
1082 1083
    if ($?) {
	print STDERR "ArchiveRollBack: ".
1084
	    "Could not mv $preswapdir to $checkin\n";
1085 1086 1087 1088 1089 1090 1091 1092 1093 1094
	return -1;
    }
    return 0;
}

#
# Swapmod completed okay. Need to commit the old preswap directory and
# move forward. 
#
sub TBExperimentArchiveSwapModCommit($$)
1095 1096
{
    my ($pid, $eid) = @_;
1097
    my ($archive_idx, $view);
1098

1099
    return -1
1100
	if (TBExperimentArchiveInfo($pid, $eid, \$archive_idx, \$view) < 0);
1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111

    my $directory;
    if (GetArchiveDirectory($archive_idx, \$directory) < 0) {
	print STDERR "ArchivePreSwapMod: ".
	    "Archive '$archive_idx' does not exist in the DB!\n";
	return -1;
    }
    if (! -d $directory || ! -w $directory) {
	print STDERR "ArchivePreSwapMod: $directory cannot be written!\n";
	return -1;
    }
1112 1113
    my $checkin    = "$directory/checkins/$view";
    my $preswapdir = "${checkin}.preswap";
1114 1115

    #
1116
    # We need this below.
1117 1118 1119 1120 1121 1122 1123 1124 1125 1126
    #
    my $query_result =
	DBQueryWarn("select s.rsrcidx from experiments as e ".
		    "left join experiment_stats as s on e.idx=s.exptidx ".
		    "where e.pid='$pid' and e.eid='$eid'");
    if (!$query_result || !$query_result->numrows) {
	return -1;
    }
    my ($rsrcidx) = $query_result->fetchrow_array();

1127 1128 1129
    #
    # Derive a useful tag.
    # 
1130 1131 1132 1133 1134 1135
    my ($seconds, $microseconds) = gettimeofday();
    my $newtag  = POSIX::strftime("T20%y%m%d-%H%M%S-", localtime());
    $newtag .= int($microseconds / 1000);
    $newtag .= "_swapmod";

    return -1
1136
	if (ArchiveCommit($archive_idx, $newtag, $view, $preswapdir) != 0);
1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161

    if (!DBQueryWarn("update experiment_resources set ".
		     "      archive_tag='$newtag' ".
		     "where idx='$rsrcidx'")) {
	return -1;
    }

    #
    # Remove the preswap dir, but if it fails keep going. Will catch it
    # next time above.
    # 
    system("/bin/rm -rf $preswapdir");
    if ($?) {
	print STDERR "*** ArchiveRollBack: Could not rm $preswapdir\n";
    }

    ($seconds, $microseconds) = gettimeofday();
    $newtag  = POSIX::strftime("T20%y%m%d-%H%M%S-", localtime());
    $newtag .= int($microseconds / 1000);
    $newtag .= "_postswapmod";

    #
    # Do a savepoint on the new tree.
    #
    return -1
1162
	if (ArchiveSavePoint($archive_idx, $newtag, $view) != 0);
1163 1164 1165 1166 1167 1168 1169 1170 1171 1172

    return 0;
}

#
# Commit an experiment archive. 
#
sub TBCommitExperimentArchive($$$)
{
    my ($pid, $eid, $tagext) = @_;
1173
    my ($archive_idx, $view);
1174

1175
    return -1
1176
	if (TBExperimentArchiveInfo($pid, $eid, \$archive_idx, \$view) < 0);
1177 1178

    #
1179
    # Need this below.
1180 1181 1182 1183 1184 1185 1186 1187 1188 1189
    #
    my $query_result =
	DBQueryWarn("select s.rsrcidx from experiments as e ".
		    "left join experiment_stats as s on e.idx=s.exptidx ".
		    "where e.pid='$pid' and e.eid='$eid'");
    if (!$query_result || !$query_result->numrows) {
	return -1;
    }
    my ($rsrcidx) = $query_result->fetchrow_array();

1190 1191 1192
    #
    # Derive a tag.
    #
1193 1194 1195 1196 1197 1198
    my ($seconds, $microseconds) = gettimeofday();
    my $newtag  = POSIX::strftime("T20%y%m%d-%H%M%S-", localtime());
    $newtag .= int($microseconds / 1000);
    $newtag .= "_${tagext}";

    return -1
1199
	if (ArchiveCommit($archive_idx, $newtag, $view) != 0);
1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214

    if (!DBQueryWarn("update experiment_resources set ".
		     "      archive_tag='$newtag' ".
		     "where idx='$rsrcidx'")) {
	return -1;
    }
    return 0;
}

#
# Archive an experiment archive to the save area.
# 
sub TBArchiveExperimentArchive($$)
{
    my ($pid, $eid) = @_;
1215
    my ($archive_idx, $view);
1216

1217 1218
    return -1
	if (TBExperimentArchiveInfo($pid, $eid, \$archive_idx, \$view) < 0);
1219 1220

    return ArchiveArchive($archive_idx, TBExptLogDir($pid, $eid));
1221 1222 1223 1224 1225 1226 1227 1228 1229
}

#
# Delete an experiment archive. This just deletes it from the active area.
# Its historical DB state is retained.
#
sub TBDeleteExperimentArchive($$)
{
    my ($pid, $eid) = @_;
1230
    my ($archive_idx, $view);
1231

1232 1233
    return -1
	if (TBExperimentArchiveInfo($pid, $eid, \$