libArchive.pm.in 44.2 KB
Newer Older
1 2 3
#!/usr/bin/perl -wT
#
# EMULAB-COPYRIGHT
Timothy Stack's avatar
Timothy Stack committed
4
# Copyright (c) 2005, 2006 University of Utah and the Flux Group.
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
# 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
use English;
use File::stat;
use File::Basename;
use POSIX qw(strftime);
use Time::HiRes qw(gettimeofday);

# Configure variables
my $TB		= "@prefix@";
Leigh B. Stoller's avatar
Leigh B. Stoller committed
30 31
my $MAINSITE    = @TBMAINSITE@;
my $ALLOWEDPID  = "testbed";
32 33 34 35 36 37 38 39
# 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";
40
my $CHGRP       = "/usr/bin/chgrp";
41
my $TAR		= "/usr/bin/tar";
Leigh B. Stoller's avatar
Leigh B. Stoller committed
42
my $RSYNC	= "/usr/local/bin/rsync";
43
my $RM		= "/bin/rm";
Leigh B. Stoller's avatar
Leigh B. Stoller committed
44
my $REALPATH	= "/bin/realpath";
45 46 47
my $SVN         = "/usr/local/bin/svn";
my $SVNADMIN    = "/usr/local/bin/svnadmin";
my $IMPORTER    = "$TB/sbin/svn_load_dirs.pl";
48
my $inittag     = 'root';
49
my $defaultview = 'head';
50
my $debug       = 0;
51
my $svnopt      = ($debug ? "" : "-q");
52 53 54 55 56 57 58 59 60 61 62

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

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

63 64 65 66 67 68 69 70 71 72 73 74 75 76 77
# Another little helper for scripts that include this library.
sub setdebug($)
{
    my ($toggle) = @_;

    if ($toggle) {
	$debug  = 1;
	$svnopt = "";
    }
    else {
	$debug  = 0;
	$svnopt = "-q";
    }
}

78 79 80 81
#
# Create a new archive. Returns -1 if any error. Otherwise return
# the new record index.
# 
82
sub ArchiveCreate(;$$$)
83
{
84
    my ($tag, $view, $unix_gid) = @_;
85
    
86 87
    my $idx;
    my $dir;
88 89 90

    $tag = $inittag
	if (!defined($tag));
91 92
    $view = $defaultview
	if (!defined($view));
93

94
    # Tags cannot must start with a letter.
95 96 97
    if ($tag =~ /^\d+/) {
	$tag = "T" . $tag;
    }
98 99 100 101 102

    #
    # Need to create the directory for it, once we have the index.
    # 
    my $query_result =
Leigh B. Stoller's avatar
Leigh B. Stoller committed
103
	DBQueryWarn("insert into archives set ".
104
		    "  idx=NULL, ".
105 106 107 108 109 110 111 112 113 114 115 116 117 118
		    "  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;
119 120 121
    if (defined($unix_gid)) {
	mysystem("$CHGRP $unix_gid $dir") == 0 or goto bad;
    }
122

Leigh B. Stoller's avatar
Leigh B. Stoller committed
123
    DBQueryWarn("update archives set directory='$dir' where idx='$idx'")
124 125 126
	or goto bad;

    #
127
    # Make subdirs. One to hold the control tree, and the other
128 129
    # to hold currently checked out versions of the tree. Lastly, we
    # need a place to copyin files before they are added to the repo.
130
    #
131
    my $repodir   = "$dir/repo";
132 133
    my $checkouts = "$dir/checkouts";
    my $checkins  = "$dir/checkins";
134

135 136
    if (! mkdir("$repodir", 0777)) {
	print STDERR "ArchiveCreate: Could not mkdir $repodir: $!\n";
137 138
	goto bad;
    }
139 140
    if (! chmod(0777, "$repodir")) {
	print STDERR "ArchiveCreate: Could not chmod $repodir: $!\n";
141 142
	goto bad;
    }
143 144
    if (! mkdir("$checkouts", 0777)) {
	print STDERR "ArchiveCreate: Could not mkdir $checkouts: $!\n";
145 146
	goto bad;
    }
147 148
    if (! chmod(0777, "$checkouts")) {
	print STDERR "ArchiveCreate: Could not chmod $checkouts: $!\n";
149 150
	goto bad;
    }
151 152
    if (! mkdir("$checkins", 0777)) {
	print STDERR "ArchiveCreate: Could not mkdir $checkins: $!\n";
153 154
	goto bad;
    }
155 156 157 158 159 160 161 162 163 164
    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";
165 166
	goto bad;
    }
167 168
    # Initialize the repo.
    mysystem("$SVNADMIN create $repodir") == 0
169
	or goto bad;
170 171 172 173
    
    # 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; ".
Leigh B. Stoller's avatar
Leigh B. Stoller committed
174
	     "         mkdir $view/history; ".
Timothy Stack's avatar
Timothy Stack committed
175
	     "$SVN import $svnopt -m 'ArchiveCreate' ".
176
	     "     $view file://$repodir/$view")
177 178 179
	== 0 or goto bad;

    # Create a branch tag in the tags directory to base differences against.
180
    mysystem("$SVN copy $svnopt -m 'ArchiveCreate Branch' ".
181 182
	     "          file://$repodir/$view/trunk ".
	     "          file://$repodir/$view/tags/${tag}-branch")
183
	== 0 or goto bad;
184
    
185 186
    # Now check it out. This creates the $checkouts/$view directory.
    mysystem("cd $checkouts; ".
187
	     "$SVN checkout $svnopt file://$repodir/$view")
188 189
	== 0 or goto bad;

190 191 192 193 194
    # 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;
    
195
    # Now enter an initial tag for the tree. Nothing actually gets tagged.
196
    DBQueryWarn("insert into archive_tags set idx=NULL, ".
197
		"  tag='$tag', archive_idx='$idx', ".
198 199 200 201 202 203 204
		"  date_created=UNIX_TIMESTAMP(now())") or goto bad;
    
    return $idx;

  bad:
#    mysystem("$RM -rf $dir")
#        if (defined($dir));
205 206 207
    DBQueryFatal("delete from archive_views ".
		 "where view='$view' and archive_idx='$idx'")
	if (defined($idx));
Leigh B. Stoller's avatar
Leigh B. Stoller committed
208
    DBQueryFatal("delete from archives where idx='$idx'")
209 210 211 212 213 214 215 216 217 218
	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. 
#
Leigh B. Stoller's avatar
Leigh B. Stoller committed
219
sub ArchiveAdd($$;$$)
220
{
Leigh B. Stoller's avatar
Leigh B. Stoller committed
221
    my ($archive_idx, $pathname, $view, $exact) = @_;
222 223 224

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

Leigh B. Stoller's avatar
Leigh B. Stoller committed
226 227 228
    $exact = 0
	if (!defined($exact));

229
    if (! -e $pathname || ! -r $pathname) {
230 231
	print STDERR "*** ArchiveFile: $pathname cannot be read!\n";
	return 0;
232 233 234 235 236 237
    }

    #
    # Check that the path does not contain an links to files outside
    # the directory space the user is allowed to access.
    #
Leigh B. Stoller's avatar
Leigh B. Stoller committed
238
    my $realpath = `$REALPATH $pathname`;
239
    if ($realpath =~ /^([-\w\/\.\+\@,~]+)$/) {
240 241 242 243 244 245 246 247 248 249
	$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/) &&
250
	! ($realpath =~ /^\/share/) &&
251 252 253 254 255 256 257 258
	! ($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. 
259
    if ($pathname =~ /^[\/]+([-\w\/\.\+\@,~]+)$/) {
260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279
	$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;
    }
280
    my $repodir   = "$directory/repo";
281 282
    my $checkout  = "$directory/checkouts/$view";
    my $checkin   = "$directory/checkins/$view";
283 284
    
    #
Leigh B. Stoller's avatar
Leigh B. Stoller committed
285 286 287 288
    # Copy the file in. We use tar on individual files (to retain the
    # directory structure and mode bits, etc). On a directory, use either
    # tar or rsync, depending on whether we want an exact copy (removing
    # files in the target that are not present in the source). 
289
    #
Leigh B. Stoller's avatar
Leigh B. Stoller committed
290 291 292 293
    if (-f "/${pathname}" || !$exact) {
	mysystem("$TAR cf - -C / $pathname | tar xf - -C $checkin");
    }
    else {
294
	mysystem("$RSYNC -R -ax --delete /${pathname} $checkin");
295 296 297 298 299 300 301 302 303
    }
    if ($?) {
	print STDERR "ArchiveFile: Could not copy in /$pathname\n";
	return -1;
    }
    return 0;
}

#
304 305 306 307 308
# 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.
309
#
Leigh B. Stoller's avatar
Leigh B. Stoller committed
310
sub ArchiveSavePoint($;$$$)
311
{
Leigh B. Stoller's avatar
Leigh B. Stoller committed
312
    my ($archive_idx, $savetag, $view, $altdir) = @_;
313 314 315 316 317 318 319 320
    my $cwd;

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

    return -1
	if (TBScriptLock("archive_${archive_idx}", 0, 120) !=
	    TBSCRIPTLOCK_OKAY());
321 322 323 324 325 326

    #
    # See if the archive exists and if it does, get the pathname to it.
    #
    my $directory;
    if (GetArchiveDirectory($archive_idx, \$directory) < 0) {
327
	print STDERR "ArchiveSavePoint: ".
328
	    "Archive '$archive_idx' does not exist in the DB!\n";
329
	goto bad;
330 331
    }
    if (! -d $directory || ! -w $directory) {
332
	print STDERR "ArchiveSavePoint: $directory cannot be written!\n";
333
	goto bad;
334
    }
335
    my $repodir   = "$directory/repo";
Leigh B. Stoller's avatar
Leigh B. Stoller committed
336
    my $checkin   = (defined($altdir) ? $altdir : "$directory/checkins/$view");
337 338 339 340 341 342

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

349
    # Get the current tag for the archive.
350 351
    my ($archive_tag);
    if (GetArchiveCurrentTags($archive_idx, $view, \$archive_tag) < 0) {
352 353 354 355 356 357 358 359 360 361 362 363 364 365
	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";
    }

366
    # Tags must start with a letter.
367 368 369 370
    if ($savetag =~ /^\d+/) {
	$savetag = "T" . $savetag;
    }
    
371
    #
372
    # Use svn import command. This is nice cause it handles all the
373 374 375
    # subdirs and stuff in one shot, instead of trying to deal with
    # each file and directory individually.
    #
376 377 378 379
    if (! chdir("$checkin")) {
	print STDERR "ArchiveSavePoint: Cannot chdir to $checkin!\n";
	goto bad;
    }
380
    mysystem("$IMPORTER -no_user_input file://$repodir ".
381
	     "          $view/savepoint . > /dev/null")
382 383 384 385 386
	== 0 or goto bad;

    #
    # Create the tag for this savepoint. 
    # 
387
    mysystem("$SVN copy $svnopt -m 'ArchiveCreate Branch' ".
388 389 390 391
	     "          file://$repodir/$view/savepoint ".
	     "          file://$repodir/$view/tags/${savetag}")
	== 0 or goto bad;
    
392 393 394 395

    #
    # And record the new tag. 
    # 
396
    DBQueryWarn("insert into archive_tags set idx=NULL, ".
397
		"  tag='$savetag', ".
398
		"  archive_idx='$archive_idx', ".
399
		"  date_created=UNIX_TIMESTAMP(now())") or goto bad;
400

401
  okay:
402 403 404
    TBScriptUnlock();
    chdir($cwd)
	if (defined($cwd));
405 406 407
    return 0;

  bad:
408 409 410
    TBScriptUnlock();
    chdir($cwd)
	if (defined($cwd));
411 412 413 414 415 416 417
    return -1;
}

#
# Commit the current contents of the temporary store to the archive.
# Returns -1 if any error. Otherwise return 0.
#
418
sub ArchiveCommit($;$$$)
419
{
420
    my ($archive_idx, $newtag, $view, $altdir) = @_;
421
    my $noactivity = 0;
422 423 424 425 426 427 428 429
    my $cwd;

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

    return -1
	if (TBScriptLock("archive_${archive_idx}", 0, 120) !=
	    TBSCRIPTLOCK_OKAY());
430 431 432 433 434 435 436 437

    #
    # 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";
438
	goto bad;
439 440 441
    }
    if (! -d $directory || ! -w $directory) {
	print STDERR "ArchiveCommit: $directory cannot be written!\n";
442
	goto bad;
443
    }
444
    my $repodir   = "$directory/repo";
445 446
    my $checkout  = "$directory/checkouts/$view";
    my $checkin   = (defined($altdir) ? $altdir : "$directory/checkins/$view");
447 448 449 450 451 452 453 454

    # Need to remember where we came from!
    chomp($cwd = `pwd`);
    # Must do the taint check too.
    if ($cwd =~ /^([-\w\.\/]+)$/) {
	$cwd = $1;
    }
    else {
Leigh B. Stoller's avatar
Leigh B. Stoller committed
455
	print STDERR "ArchiveCommit: Bad data in $cwd!\n";
456
	goto bad;
457 458
    }

Leigh B. Stoller's avatar
Leigh B. Stoller committed
459 460
    if (! chdir("$directory")) {
	print STDERR "ArchiveCommit: Cannot chdir to $directory!\n";
461
	goto bad;
462 463 464
    }

    # Get the current tags for the archive.
465
    my ($archive_tag, $previous_tag);
466
    if (GetArchiveCurrentTags($archive_idx, $view, \$archive_tag,
467
			      \$previous_tag) < 0) {
468 469 470 471 472 473
	print STDERR "ArchiveCommit: ".
	    "Archive '$archive_idx' does not have a current tag!\n";
	goto bad;
    }

    #
474 475
    # Form new tag.
    # 
476 477 478
    my ($seconds, $microseconds) = gettimeofday();
    my $import_tag  = POSIX::strftime("T20%y%m%d-%H%M%S-", localtime());
    $import_tag    .= $microseconds;
479 480

    if (!defined($newtag)) {
481
	$newtag = $import_tag . "_commit";
482 483
    }

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

489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506
    #
    # 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;
    }
    
507
    #
508 509 510
    # Okay, do the commit to the trunk for this view.
    # 
    if (! $noactivity) {
Leigh B. Stoller's avatar
Leigh B. Stoller committed
511 512 513 514 515 516 517 518 519
	#
	# Create a temporary spot to work in.
	# 
	if (! mkdir("merge.$$", 0777)) {
	    print STDERR "ArchiveCommit: Could not mkdir merge.$$: $!\n";
	    goto bad;
	}
	chdir("merge.$$");
	
520
	#
521
	# Check out the current trunk.
522
	#
523 524 525
	mysystem("$SVN checkout $svnopt file://$repodir/$view/trunk")
	    == 0 or goto bad;

526
	#
527 528 529 530 531 532 533 534 535 536
	# 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;
537

538 539 540 541 542 543
	#
	# Now commit to the trunk!
	#
	mysystem("$SVN commit $svnopt ".
		 "     -m 'Commit merge of ${archive_tag} to trunk' trunk")
	    == 0 or goto bad;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
544 545 546 547 548 549 550

	# Clean the temp dir,
	chdir("$directory");
	mysystem("/bin/rm -rf merge.$$");
	if ($?) {
	    print STDERR "ArchiveCommit: Could not remove merge.$$\n";
	}
551
    }
552

553
    # Create a tag in the tags directory for the commit.
554
    mysystem("$SVN copy $svnopt -m 'ArchiveCommit' ".
555 556 557 558
	     "          file://$repodir/$view/trunk ".
	     "          file://$repodir/$view/tags/${newtag}")
	== 0 or goto bad;
    
Leigh B. Stoller's avatar
Leigh B. Stoller committed
559 560 561
    # Create a tag in the history directory for the commit. The
    # history directory has just the commit tags, so its easy to go
    # back in time.
562
    mysystem("$SVN copy $svnopt -m 'ArchiveCommit' ".
Leigh B. Stoller's avatar
Leigh B. Stoller committed
563 564 565 566
	     "          file://$repodir/$view/trunk ".
	     "          file://$repodir/$view/history/${newtag}")
	== 0 or goto bad;
    
567
    # Create a branch tag in the tags directory to base differences against.
568
    mysystem("$SVN copy $svnopt -m 'ArchiveCommit Branch' ".
569 570 571 572
	     "          file://$repodir/$view/trunk ".
	     "          file://$repodir/$view/tags/${newtag}-branch")
	== 0 or goto bad;
    
573
    DBQueryWarn("insert into archive_tags set idx=NULL, ".
574
		"  tag='$newtag', ".
575
		"  archive_idx='$archive_idx', ".
576 577
		"  date_created=UNIX_TIMESTAMP(now())")
	or goto bad;
578

579
    DBQueryWarn("update archive_views set ".
580
		"  current_tag='$newtag', ".
581
		"  previous_tag='$archive_tag' ".
582 583
		"where archive_idx='$archive_idx' and view='$view'")
	or goto bad;
584 585

    # Clean the temp dir for later.
Leigh B. Stoller's avatar
Leigh B. Stoller committed
586 587 588 589 590 591 592 593 594 595 596 597 598 599 600
   if (0) {
    if (!defined($altdir)) {
	mysystem("/bin/rm -rf $checkin");
	if ($?) {
	    print STDERR "ArchiveCommit: Could not remove $checkin!\n";
	    goto bad;
	}
	if (! mkdir("$checkin", 0777)) {
	    print STDERR "ArchiveCommit: Could not mkdir $checkin: $!\n";
	    goto bad;
	}
	if (! chmod(0777, "$checkin")) {
	    print STDERR "ArchiveCommit: Could not chmod $checkin: $!\n";
	    goto bad;
	}
601
    }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
602
   }
603

604 605 606
    # And now into the checkout dir to checkout a current copy.
    if (! chdir("$checkout")) {
	print STDERR "ArchiveCommit: Cannot chdir to $checkout!\n";
607
	goto bad;
608
    }
609
    mysystem("$SVN $svnopt update trunk");
610
    if ($?) {
611
	print STDERR "ArchiveCommit: Could not update head revision!\n";
612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631
	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.
#
632
sub ArchiveFork($$;$$$)
633
{
634 635
    my ($archive_idx, $newview, $branchtag, $newtag, $view) = @_;
    my $sourcepoint;
636 637 638 639 640 641 642 643 644 645 646 647 648 649
    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) {
650
	print STDERR "ArchiveCommit: ".
651 652 653 654 655
	    "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";
656
	goto bad;
657
    }
658
    my $repodir     = "$directory/repo";
659 660 661 662 663 664 665 666 667 668 669 670 671
    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 {
Leigh B. Stoller's avatar
Leigh B. Stoller committed
672
	print STDERR "ArchiveFork: Bad data in $cwd!\n";
673 674 675 676
	goto bad;
    }

    # Get the current tags for the archive.
677
    my ($archive_tag, $previous_tag);
678
    if (GetArchiveCurrentTags($archive_idx, $view, \$archive_tag,
679
			      \$previous_tag) < 0) {
680 681 682 683 684
	print STDERR "ArchiveCommit: ".
	    "Archive '$archive_idx' does not have a current tag!\n";
	goto bad;
    }

685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700
    #
    # 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;
    }

701 702 703 704 705 706 707 708 709
    # 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;
    }
710 711

    # Create newview directory in the repo.
712
    mysystem("$SVN mkdir $svnopt -m 'ArchiveFork' ".
713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730
	     "          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.
731
    mysystem("$SVN mkdir $svnopt -m 'ArchiveFork' ".
732 733 734 735 736
	     "          file://$repodir/$newview/savepoint ".
	     "          file://$repodir/$newview/tags")
	== 0 or goto bad;

    # Now check it out. This creates the checkouts/$newview directory.
737
    mysystem("cd $checkouts; ".
738
	     "$SVN checkout $svnopt file://$repodir/$newview")
739 740
	== 0 or goto bad;

741 742 743 744 745
    # 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;
746
    
747 748 749 750
    # 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;
751

752
  okay:
753 754 755
    TBScriptUnlock();
    chdir($cwd)
	if (defined($cwd));
756
    return 0;
757 758

  bad:
759 760 761
    TBScriptUnlock();
    chdir($cwd)
	if (defined($cwd));
762
    return -1;
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 798 799 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 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846
#
# Checkout a copy of the archive, optionally at a particular view/branch.
#
sub ArchiveCheckout($$;$$)
{
    my ($archive_idx, $target, $view, $tag) = @_;
    my $sourcepoint;
    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) {
	print STDERR "ArchiveCheckout: ".
	    "Archive '$archive_idx' does not exist in the DB!\n";
	goto bad;
    }
    if (! -d $directory || ! -w $directory) {
	print STDERR "ArchiveCheckout: $directory cannot be written!\n";
	goto bad;
    }
    my $repodir     = "$directory/repo";

    #
    # We allow target to exist or not exist.
    #
    if (! -e $target) {
	if (! mkdir("$target", 0777)) {
	    print STDERR "ArchiveCheckout: Could not mkdir $target: $!\n";
	    return -1;
	}
	if (! chmod(0777, "$target")) {
	    print STDERR "ArchiveCheckout: ".
		"Could not chmod directory $target: $!\n";
	    return -1;
	}
    }

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

    # Where to find what we want.
    if (defined($tag)) {
	$sourcepoint = "tags/$tag";
    }
    else {
	$sourcepoint = "trunk"
    }

    # Now check it out. This creates the $checkouts/$view directory.
    mysystem("cd $target; ".
	     "$SVN checkout $svnopt file://$repodir/$view/$sourcepoint .")
	== 0 or goto bad;
  okay:
    TBScriptUnlock();
    chdir($cwd)
	if (defined($cwd));
    return 0;

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

847 848 849 850 851 852 853 854 855 856 857 858 859 860 861
#
# 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) {
862
	print STDERR "ArchiveArchive: ".
863 864 865
	    "Archive '$archive_idx' does not exist in the DB!\n";
	return -1;
    }
866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881

    #
    # Need additional check to make sure that it has not already been
    # archived.
    #
    my ($archived, $date_archived);
    
    if (IsArchiveArchived($archive_idx, \$archived, \$date_archived) < 0) {
	return -1;
    }
    if ($archived) {
	print STDERR "ArchiveArchive: ".
	    "Archive '$archive_idx' already archived on $date_archived!\n";
	return 0;
    }
    
882
    if (! -d $directory || ! -w $directory) {
883
	print STDERR "ArchiveArchive: $directory cannot be written!\n";
884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901
	return -1;
    }

    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.
    #
902
    mysystem("$TAR cf - -C $directory repo | tar xf - -C $target");
903 904 905 906
    if ($?) {
	print STDERR "ArchiveArchive: Could not copy in $directory\n";
	return -1;
    }
907 908 909 910

    #
    # Update its location in the DB, and remove the old directory.
    # 
911 912 913 914
    DBQueryWarn("update archives set ".
		"   directory='$target', ".
		"   archived=1, ".
		"   date_archived=UNIX_TIMESTAMP(now()) ".
915 916 917 918 919 920 921 922 923
		"where idx='$archive_idx'")
	or return -1;
    
    mysystem("/bin/rm -rf $directory");
    if ($?) {
	print STDERR "ArchiveArchive: ".
	    "Could not remove contents of $directory!\n";
	return -1;
    }
924 925 926 927 928 929 930
    return 0;
}

#
# Destroy an archive. The DB state is retained unless optional flag says
# to clean it.
#
931
sub ArchiveDestroy($$)
932 933 934 935 936 937 938 939 940 941 942 943
{
    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;
    }
944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959

    #
    # Need additional check to make sure that it has not already been
    # archived. Do not want to do anything, unless clean is specified.
    #
    my ($archived, $date_archived);
    
    if (IsArchiveArchived($archive_idx, \$archived, \$date_archived) < 0) {
	return -1;
    }
    if ($archived && !$clean) {
	print STDERR "ArchiveDestroy: ".
	    "Archive '$archive_idx' archived on $date_archived!\n";
	return 0;
    }
    
960 961 962 963 964 965 966 967 968 969
    if (! -d $directory || ! -w $directory) {
	return 0;
    }

    mysystem("/bin/rm -rf $directory");
    if ($?) {
	print STDERR "ArchiveDestroy: ".
	    "Could not remove contents of $directory!\n";
	return -1;
    }
970
    if ($clean) {
971 972
	(DBQueryWarn("delete from archive_tags ".
		     "where archive_idx='$archive_idx'") &&
973 974
	 DBQueryWarn("delete from archive_views ".
		     "where archive_idx='$archive_idx'") &&
Leigh B. Stoller's avatar
Leigh B. Stoller committed
975
	 DBQueryWarn("delete from archives ".
976 977 978 979 980 981 982 983 984 985 986 987 988 989
		     "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 =
Leigh B. Stoller's avatar
Leigh B. Stoller committed
990
	DBQueryWarn("select directory from archives where idx='$idx'");
991 992 993 994 995 996 997 998 999 1000

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

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

1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024
#
# See if the archive has already been archived away, and when.
#
sub IsArchiveArchived($$$)
{
    my ($idx, $parch, $pdate) = @_;
    
    my $query_result =
	DBQueryWarn("select archived,FROM_UNIXTIME(date_archived) ".
		    "  from archives where idx='$idx'");

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

    $$parch = $archived
	if (defined($parch));
    $$pdate = $date_archived
	if (defined($pdate));
    
    return 0;
}

1025 1026 1027 1028
#
# Get the current tag for an archive, given its index. Returns -1 on error,
# zero otherwise. Place tag in the return pointer.
#
1029
sub GetArchiveCurrentTags($$$;$)
1030
{
1031
    my ($archive_idx, $view, $tagp, $prevp) = @_;
1032 1033
    
    my $query_result =
1034
	DBQueryWarn("select v.current_tag,v.previous_tag ".
1035 1036 1037 1038 1039 1040
		    "    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'");
1041 1042 1043

    return -1
	if (!$query_result);
1044
    my ($tag,$previous) = $query_result->fetchrow_array();
1045
    
1046 1047 1048 1049
    $$tagp = $tag
	if (defined($tagp));
    $$prevp = $previous
	if (defined($prevp));
1050 1051 1052 1053 1054 1055 1056 1057
    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.
#
1058
sub TBExperimentArchiveInfo($$$$)
1059
{
1060
    my ($pid, $eid, $idxp, $viewp) = @_;
1061 1062

    my $query_result =
1063
	DBQueryWarn("select s.archive_idx,e.idx from experiments as e ".
1064 1065 1066 1067 1068 1069
		    "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);

1070
    my ($archive_idx,$exptidx) = $query_result->fetchrow_array();
1071

1072 1073 1074
    # Need to deal with no archive yet!
    return 1
	if (!defined($archive_idx) || $archive_idx == 0);
1075 1076 1077 1078 1079

    $$idxp = $archive_idx
	if (defined($idxp));
    $$viewp = "$exptidx"
	if (defined($viewp));
1080
    
1081
    return 0;
1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094
}

#
# 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) = @_;

Leigh B. Stoller's avatar
Leigh B. Stoller committed
1095 1096 1097
    return 0
	if (!$MAINSITE || $pid ne $ALLOWEDPID);

1098 1099 1100 1101 1102 1103 1104 1105 1106 1107
    # 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();
1108 1109
    my $archive_tag = "T${rsrcidx}";

1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121
    #
    # The point of this is to set the group of the new directory.
    #
    my $gid = ExpGroup($pid, $eid);
    if (! $gid) {
	return -1;
    }
    my ($unix_gid, $unix_name);
    if (!TBGroupUnixInfo($pid, $gid, \$unix_gid, \$unix_name)) {
	return -1;
    }

1122 1123 1124
    #
    # Create the new archive and get back the new index. 
    #
1125
    my $archive_idx = ArchiveCreate($archive_tag, "$exptidx", $unix_name);
1126 1127
    return -1
	if ($archive_idx < 0);
1128 1129 1130 1131 1132 1133

    if (! (DBQueryWarn("update experiment_stats set ".
		       "      archive_idx='$archive_idx' ".
		       "where pid='$pid' and eid='$eid' and ".
		       "      exptidx='$exptidx'") &&
	   DBQueryWarn("update experiment_resources set ".
1134
		       "      archive_tag='$archive_tag' ".
1135 1136 1137 1138 1139
		       "where idx='$rsrcidx'"))) {
	ArchiveDestroy($archive_idx, 1);
	return -1;
    }
    return 0;
1140 1141 1142 1143

  bad:
    ArchiveDestroy($archive_idx, 1);
    return -1;
1144 1145 1146 1147 1148 1149 1150 1151
}

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

Leigh B. Stoller's avatar
Leigh B. Stoller committed
1154 1155 1156
    return 0
	if (!$MAINSITE || $pid ne $ALLOWEDPID);

1157 1158 1159
    my $rval = TBExperimentArchiveInfo($pid, $eid, \$archive_idx, \$view);
    return 0
	if ($rval > 0);
1160
    return -1
1161
	if ($rval < 0);
1162

1163
    return ArchiveAdd($archive_idx, $pathname, $view);
1164 1165
}

1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176
#
# Add files picked up by NFS tracing to an experiment archive.
#
sub TBExperimentArchiveAddTracedFiles($$)
{
    my ($pid, $eid) = @_;
    my ($archive_idx, $view);

    return 0
	if (!$MAINSITE || $pid ne $ALLOWEDPID);

1177 1178
    return 0;

1179 1180 1181 1182 1183 1184 1185 1186 1187 1188