libArchive.pm.in 31.3 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 40
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";
my $CVSBIN      = "/usr/bin/cvs";
41 42 43
my $SVN         = "/usr/local/bin/svn";
my $SVNADMIN    = "/usr/local/bin/svnadmin";
my $IMPORTER    = "$TB/sbin/svn_load_dirs.pl";
44
my $inittag     = 'root';
45
my $defaultview = 'head';
46
my $debug       = 1;
47
my $cvsopt      = ($debug ? "" : "-q");
48
my $svnopt      = ($debug ? "" : "-q");
49 50 51 52 53 54 55 56 57 58 59 60 61 62 63

# 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.
# 
64
sub ArchiveCreate(;$$)
65
{
66
    my ($tag, $view) = @_;
67
    
68 69
    my $idx;
    my $dir;
70 71 72

    $tag = $inittag
	if (!defined($tag));
73 74
    $view = $defaultview
	if (!defined($view));
75 76 77 78 79

    # CVS tags cannot must start with a letter.
    if ($tag =~ /^\d+/) {
	$tag = "T" . $tag;
    }
80 81 82 83 84 85

    #
    # Need to create the directory for it, once we have the index.
    # 
    my $query_result =
	DBQueryWarn("insert into file_archives set ".
86
		    "  idx=NULL, ".
87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105
		    "  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;

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

114 115
    if (! mkdir("$repodir", 0777)) {
	print STDERR "ArchiveCreate: Could not mkdir $repodir: $!\n";
116 117
	goto bad;
    }
118 119
    if (! chmod(0777, "$repodir")) {
	print STDERR "ArchiveCreate: Could not chmod $repodir: $!\n";
120 121
	goto bad;
    }
122 123
    if (! mkdir("$checkouts", 0777)) {
	print STDERR "ArchiveCreate: Could not mkdir $checkouts: $!\n";
124 125
	goto bad;
    }
126 127
    if (! chmod(0777, "$checkouts")) {
	print STDERR "ArchiveCreate: Could not chmod $checkouts: $!\n";
128 129
	goto bad;
    }
130 131
    if (! mkdir("$checkins", 0777)) {
	print STDERR "ArchiveCreate: Could not mkdir $checkins: $!\n";
132 133
	goto bad;
    }
134 135 136 137 138 139 140 141 142 143
    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";
144 145
	goto bad;
    }
146 147
    # Initialize the repo.
    mysystem("$SVNADMIN create $repodir") == 0
148
	or goto bad;
149 150 151 152 153 154 155 156 157 158 159
    
    # 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")
160
	== 0 or goto bad;
161
    
162 163
    # Now check it out. This creates the $checkouts/$view directory.
    mysystem("cd $checkouts; ".
164
	     "$SVN checkout $svnopt file://$repodir/$view")
165 166
	== 0 or goto bad;

167 168 169 170 171
    # 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;
    
172
    # Now enter an initial tag for the tree. Nothing actually gets tagged.
173
    DBQueryWarn("insert into archive_tags set idx=NULL, ".
174
		"  tag='$tag', archive_idx='$idx', ".
175 176 177 178 179 180 181
		"  date_created=UNIX_TIMESTAMP(now())") or goto bad;
    
    return $idx;

  bad:
#    mysystem("$RM -rf $dir")
#        if (defined($dir));
182 183 184
    DBQueryFatal("delete from archive_views ".
		 "where view='$view' and archive_idx='$idx'")
	if (defined($idx));
185 186 187 188 189 190 191 192 193 194 195
    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. 
#
196
sub ArchiveAdd($$;$)
197
{
198 199 200 201
    my ($archive_idx, $pathname, $view) = @_;

    $view = $defaultview
	if (!defined($view));
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 255 256

    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;
    }
257
    my $repodir   = "$directory/repo";
258 259
    my $checkout  = "$directory/checkouts/$view";
    my $checkin   = "$directory/checkins/$view";
260 261 262 263 264
    
    #
    # See if the file is already in the archive. We currently deal with
    # just files; directories are gonna be a pain in the butt.
    #
265
    my $target_path = "$checkin/$pathname";
266 267 268 269 270 271

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

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

#
288 289 290 291 292
# 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.
293
#
294
sub ArchiveSavePoint($;$$)
295
{
296 297 298 299 300 301 302 303 304
    my ($archive_idx, $savetag, $view) = @_;
    my $cwd;

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

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

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

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

334
    # Get the current tag for the archive.
335 336
    my ($archive_tag);
    if (GetArchiveCurrentTags($archive_idx, $view, \$archive_tag) < 0) {
337 338 339 340 341 342 343 344 345 346 347 348 349 350
	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";
    }

351
    # CVS tags must start with a letter.
352 353 354 355
    if ($savetag =~ /^\d+/) {
	$savetag = "T" . $savetag;
    }
    
356
    #
357
    # Use svn import command. This is nice cause it handles all the
358 359 360
    # subdirs and stuff in one shot, instead of trying to deal with
    # each file and directory individually.
    #
361 362 363 364
    if (! chdir("$checkin")) {
	print STDERR "ArchiveSavePoint: Cannot chdir to $checkin!\n";
	goto bad;
    }
365 366 367 368 369 370 371 372 373 374 375 376
    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;
    
377 378 379 380

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

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

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

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

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

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

    #
    # 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";
423
	goto bad;
424 425 426
    }
    if (! -d $directory || ! -w $directory) {
	print STDERR "ArchiveCommit: $directory cannot be written!\n";
427
	goto bad;
428
    }
429
    my $repodir   = "$directory/repo";
430 431
    my $checkout  = "$directory/checkouts/$view";
    my $checkin   = (defined($altdir) ? $altdir : "$directory/checkins/$view");
432 433 434 435 436 437 438 439 440

    # 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";
441
	goto bad;
442 443
    }

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

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

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

    if (!defined($newtag)) {
466
	$newtag = $import_tag . "_commit";
467 468 469 470 471 472
    }

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

474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491
    #
    # 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;
    }
    
492
    # Clean the temp dir for next phase.
493
    mysystem("/bin/rm -rf $checkin/*");
494
    if ($?) {
495
	print STDERR "ArchiveCommit: Could not clean $checkin!\n";
496
	goto bad;
497 498 499
    }

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

509
	#
510 511 512 513 514 515 516 517 518 519
	# 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;
520

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

529 530 531 532 533 534 535 536 537 538 539 540
    # 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;
    
541
    DBQueryWarn("insert into archive_tags set idx=NULL, ".
542
		"  tag='$newtag', ".
543
		"  archive_idx='$archive_idx', ".
544 545
		"  date_created=UNIX_TIMESTAMP(now())")
	or goto bad;
546

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

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

560 561 562
    # And now into the checkout dir to checkout a current copy.
    if (! chdir("$checkout")) {
	print STDERR "ArchiveCommit: Cannot chdir to $checkout!\n";
563
	goto bad;
564
    }
565
    mysystem("$SVN $svnopt update trunk");
566
    if ($?) {
567
	print STDERR "ArchiveCommit: Could not update head revision!\n";
568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604
	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.
#
sub ArchiveFork($$;$)
{
    my ($archive_idx, $newview, $view) = @_;
    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) {
605
	print STDERR "ArchiveCommit: ".
606 607 608 609 610
	    "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";
611
	goto bad;
612
    }
613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631
    my $cvsdir      = "$directory/repo";
    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.
632
    my ($archive_tag, $previous_tag);
633
    if (GetArchiveCurrentTags($archive_idx, $view, \$archive_tag,
634
			      \$previous_tag) < 0) {
635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650
	print STDERR "ArchiveCommit: ".
	    "Archive '$archive_idx' does not have a current tag!\n";
	goto bad;
    }

    # 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;
    }
    # Now checkout new view; this creates the $checkouts/$newview directory.
    mysystem("cd $checkouts; ".
651
	     "$CVSBIN $cvsopt -d $cvsdir checkout root; ".
652 653 654 655 656
	     "/bin/mv root ${newview}")
	== 0 or goto bad;

    

657
  okay:
658 659 660
    TBScriptUnlock();
    chdir($cwd)
	if (defined($cwd));
661
    return 0;
662 663

  bad:
664 665 666
    TBScriptUnlock();
    chdir($cwd)
	if (defined($cwd));
667
    return -1;
668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692
}

#
# 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;
    }
693
    my $cvsdir  = "$directory/repo";
694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709

    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.
    #
710
    mysystem("$TAR cf - -C $cvsdir . | tar xf - -C $target");
711 712 713 714 715 716 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 742 743 744 745 746 747 748
    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'") &&
749 750
	 DBQueryWarn("delete from archive_views ".
		     "where archive_idx='$archive_idx'") &&
751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780
	 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.
#
781
sub GetArchiveCurrentTags($$$;$)
782
{
783
    my ($archive_idx, $view, $tagp, $prevp) = @_;
784 785
    
    my $query_result =
786
	DBQueryWarn("select v.current_tag,v.previous_tag ".
787 788 789 790 791 792
		    "    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'");
793 794 795

    return -1
	if (!$query_result);
796
    my ($tag,$previous) = $query_result->fetchrow_array();
797
    
798 799 800 801
    $$tagp = $tag
	if (defined($tagp));
    $$prevp = $previous
	if (defined($prevp));
802 803 804 805 806 807 808 809
    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.
#
810
sub TBExperimentArchiveInfo($$$$)
811
{
812
    my ($pid, $eid, $idxp, $viewp) = @_;
813 814

    my $query_result =
815
	DBQueryWarn("select s.archive_idx,e.idx from experiments as e ".
816 817 818 819 820 821
		    "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);

822
    my ($archive_idx,$exptidx) = $query_result->fetchrow_array();
823 824

    return -1
825 826 827 828 829 830
	if (!defined($archive_idx));

    $$idxp = $archive_idx
	if (defined($idxp));
    $$viewp = "$exptidx"
	if (defined($viewp));
831
    
832
    return 0;
833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855
}

#
# 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();
856 857 858 859 860
    my $archive_tag = "T${rsrcidx}";

    #
    # Create the new archive and get back the new index. 
    #
861
    my $archive_idx = ArchiveCreate($archive_tag, "$exptidx");
862 863
    return -1
	if ($archive_idx < 0);
864 865 866 867 868 869

    if (! (DBQueryWarn("update experiment_stats set ".
		       "      archive_idx='$archive_idx' ".
		       "where pid='$pid' and eid='$eid' and ".
		       "      exptidx='$exptidx'") &&
	   DBQueryWarn("update experiment_resources set ".
870
		       "      archive_tag='$archive_tag' ".
871 872 873 874 875 876 877 878 879 880 881 882 883
		       "where idx='$rsrcidx'"))) {
	ArchiveDestroy($archive_idx, 1);
	return -1;
    }
    return 0;
}

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

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

889
    return ArchiveAdd($archive_idx, $pathname, $view);
890 891 892
}

#
893
# SavePoint an experiment archive. 
894
#
895 896 897
sub TBExperimentArchiveSavePoint($$$)
{
    my ($pid, $eid, $tagext) = @_;
898
    my ($archive_idx, $view);
899 900

    return -1
901
	if (TBExperimentArchiveInfo($pid, $eid, \$archive_idx, \$view) < 0);
902 903

    #
904
    # Derive a tag that contains some useful info?
905 906 907 908 909 910
    #
    my ($seconds, $microseconds) = gettimeofday();
    my $newtag  = POSIX::strftime("T20%y%m%d-%H%M%S-", localtime());
    $newtag .= int($microseconds / 1000);
    $newtag .= "_${tagext}";

911
    return ArchiveSavePoint($archive_idx, $newtag, $view);
912 913 914 915 916 917 918 919
}

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

    return -1
923
	if (TBExperimentArchiveInfo($pid, $eid, \$archive_idx, \$view) < 0);
924 925 926 927 928 929 930 931 932 933 934

    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;
    }
935 936
    my $checkin    = "$directory/checkins/$view";
    my $preswapdir = "${checkin}.preswap";
937 938

    #
939
    # Derive a tag that says something useful?
940 941 942 943 944 945 946 947 948 949
    #
    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
950
	if (ArchiveSavePoint($archive_idx, $newtag, $view) != 0);
951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973

    #
    # 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;
    }
    
974
    mysystem("$TAR cf - -C $checkin . | tar xf - -C $preswapdir");
975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998
    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) = @_;
999
    my ($archive_idx, $view);
1000 1001

    return -1
1002
	if (TBExperimentArchiveInfo($pid, $eid, \$archive_idx, \$view) < 0);
1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013

    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;
    }
1014 1015
    my $checkin    = "$directory/checkins/$view";
    my $preswapdir = "${checkin}.preswap";
1016 1017 1018 1019 1020 1021 1022 1023

    # 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.
    #
1024 1025 1026
    if (-e $checkin) {
	system("/bin/rm -rf $checkin");
	if (-e $checkin) {
1027 1028 1029 1030 1031
	    print STDERR
		"ArchiveRollBack: Could not delete old preswap dir!\n";
	    return -1;
	}
    }
1032
    system("/bin/mv -f $preswapdir $checkin");
1033 1034
    if ($?) {
	print STDERR "ArchiveRollBack: ".
1035
	    "Could not mv $preswapdir to $checkin\n";
1036 1037 1038 1039 1040 1041 1042 1043 1044 1045
	return -1;
    }
    return 0;
}

#
# Swapmod completed okay. Need to commit the old preswap directory and
# move forward. 
#
sub TBExperimentArchiveSwapModCommit($$)
1046 1047
{
    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 "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;
    }
1063 1064
    my $checkin    = "$directory/checkins/$view";
    my $preswapdir = "${checkin}.preswap";
1065 1066

    #
1067
    # We need this below.
1068 1069 1070 1071 1072 1073 1074 1075 1076 1077
    #
    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();

1078 1079 1080
    #
    # Derive a useful tag.
    # 
1081 1082 1083 1084 1085 1086
    my ($seconds, $microseconds) = gettimeofday();
    my $newtag  = POSIX::strftime("T20%y%m%d-%H%M%S-", localtime());
    $newtag .= int($microseconds / 1000);
    $newtag .= "_swapmod";

    return -1
1087
	if (ArchiveCommit($archive_idx, $newtag, $view, $preswapdir) != 0);
1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112

    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
1113
	if (ArchiveSavePoint($archive_idx, $newtag, $view) != 0);
1114 1115 1116 1117 1118 1119 1120 1121 1122 1123

    return 0;
}

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

1126
    return -1
1127
	if (TBExperimentArchiveInfo($pid, $eid, \$archive_idx, \$view) < 0);
1128 1129

    #
1130
    # Need this below.
1131 1132 1133 1134 1135 1136 1137 1138 1139 1140
    #
    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();

1141 1142 1143
    #
    # Derive a tag.
    #
1144 1145 1146 1147 1148 1149
    my ($seconds, $microseconds) = gettimeofday();
    my $newtag  = POSIX::strftime("T20%y%m%d-%H%M%S-", localtime());
    $newtag .= int($microseconds / 1000);
    $newtag .= "_${tagext}";

    return -1
1150
	if (ArchiveCommit($archive_idx, $newtag, $view) != 0);
1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165

    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) = @_;
1166
    my ($archive_idx, $view);
1167

1168 1169
    return -1
	if (TBExperimentArchiveInfo($pid, $eid, \$archive_idx, \$view) < 0);
1170 1171

    return ArchiveArchive($archive_idx, TBExptLogDir($pid, $eid));
1172 1173 1174 1175 1176 1177 1178 1179 1180
}

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

1183 1184
    return -1
	if (TBExperimentArchiveInfo($pid, $eid, \$archive_idx, \$view) < 0);
1185 1186 1187 1188 1189 1190 1191 1192 1193 1194

    return ArchiveDestroy($archive_idx, 0);
}

#
# Destroy an experiment archive. Totally flush it from the system.
#
sub TBDestroyExperimentArchive($$)
{
    my ($pid, $eid) = @_;
1195
    my ($archive_idx, $view);
1196

1197 1198
    return -1
	if (TBExperimentArchiveInfo($pid, $eid, \$archive_idx, \$view) < 0);
Leigh B. Stoller's avatar