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

59 60 61 62 63
my $TAGTYPE_USER      = "user";
my $TAGTYPE_COMMIT    = "commit";
my $TAGTYPE_SAVEPOINT = "savepoint";
my $TAGTYPE_INTERNAL  = "internal";

64 65 66 67 68
#
# Set umask so that other people in the project can mess with the archive.
#
umask(0002);

69 70 71 72 73 74 75 76 77 78 79 80

# On or off
sub doarchiving($)
{
    my ($pid) = @_;
    
    return 1
	if ($USEARCHIVE && exists($ALLOWEDPID{$pid}));
    
    return 0;
}

81 82 83 84 85 86 87 88 89 90
# Little helper and debug function.
sub mysystem($)
{
    my ($command) = @_;

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

91 92 93 94 95 96
# Another little helper for scripts that include this library.
sub setdebug($)
{
    my ($toggle) = @_;

    if ($toggle) {
97
	$debug  = $toggle;
98 99 100 101 102 103 104 105
	$svnopt = "";
    }
    else {
	$debug  = 0;
	$svnopt = "-q";
    }
}

106 107 108 109
#
# Create a new archive. Returns -1 if any error. Otherwise return
# the new record index.
# 
110
sub ArchiveCreate(;$$$)
111
{
112
    my ($tag, $view, $unix_gid) = @_;
113
    
114 115
    my $idx;
    my $dir;
116 117 118

    $tag = $inittag
	if (!defined($tag));
119 120
    $view = $defaultview
	if (!defined($view));
121

122
    # Tags cannot must start with a letter.
123 124 125
    if ($tag =~ /^\d+/) {
	$tag = "T" . $tag;
    }
126 127 128 129 130

    #
    # Need to create the directory for it, once we have the index.
    # 
    my $query_result =
Leigh B. Stoller's avatar
Leigh B. Stoller committed
131
	DBQueryWarn("insert into archives set ".
132
		    "  idx=NULL, ".
133 134 135 136 137 138 139 140 141 142 143 144 145 146
		    "  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;
147 148 149
    if (defined($unix_gid)) {
	mysystem("$CHGRP $unix_gid $dir") == 0 or goto bad;
    }
150

Leigh B. Stoller's avatar
Leigh B. Stoller committed
151
    DBQueryWarn("update archives set directory='$dir' where idx='$idx'")
152 153 154
	or goto bad;

    #
155
    # Make subdirs. One to hold the control tree, and the other
156 157
    # to hold currently checked out versions of the tree. Lastly, we
    # need a place to copyin files before they are added to the repo.
158
    #
159
    my $repodir   = "$dir/repo";
160 161
    my $checkouts = "$dir/checkouts";
    my $checkins  = "$dir/checkins";
162

163 164
    if (! mkdir("$repodir", 0777)) {
	print STDERR "ArchiveCreate: Could not mkdir $repodir: $!\n";
165 166
	goto bad;
    }
167 168
    if (! chmod(0777, "$repodir")) {
	print STDERR "ArchiveCreate: Could not chmod $repodir: $!\n";
169 170
	goto bad;
    }
171 172
    if (! mkdir("$checkouts", 0777)) {
	print STDERR "ArchiveCreate: Could not mkdir $checkouts: $!\n";
173 174
	goto bad;
    }
175 176
    if (! chmod(0777, "$checkouts")) {
	print STDERR "ArchiveCreate: Could not chmod $checkouts: $!\n";
177 178
	goto bad;
    }
179 180
    if (! mkdir("$checkins", 0777)) {
	print STDERR "ArchiveCreate: Could not mkdir $checkins: $!\n";
181 182
	goto bad;
    }
183 184 185 186 187 188 189 190 191 192
    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";
193 194
	goto bad;
    }
195 196
    # Initialize the repo.
    mysystem("$SVNADMIN create $repodir") == 0
197
	or goto bad;
198 199 200 201
    
    # 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
202
	     "         mkdir $view/history; ".
Timothy Stack's avatar
Timothy Stack committed
203
	     "$SVN import $svnopt -m 'ArchiveCreate' ".
204
	     "     $view file://$repodir/$view")
205 206 207
	== 0 or goto bad;

    # Create a branch tag in the tags directory to base differences against.
208
    mysystem("$SVN copy $svnopt -m 'ArchiveCreate Branch' ".
209 210
	     "          file://$repodir/$view/trunk ".
	     "          file://$repodir/$view/tags/${tag}-branch")
211
	== 0 or goto bad;
212
    
213 214
    # Now check it out. This creates the $checkouts/$view directory.
    mysystem("cd $checkouts; ".
215
	     "$SVN checkout $svnopt file://$repodir/$view")
216 217
	== 0 or goto bad;

218 219 220 221 222
    # 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;
    
223
    # Now enter an initial tag for the tree. Nothing actually gets tagged.
224 225
    DBQueryWarn("insert into archive_tags set idx=NULL, ".
		"  tag='$tag', archive_idx='$idx', view='$view', ".
226
		"  tagtype='$TAGTYPE_INTERNAL', ".
227 228 229 230 231 232 233
		"  date_created=UNIX_TIMESTAMP(now())") or goto bad;
    
    return $idx;

  bad:
#    mysystem("$RM -rf $dir")
#        if (defined($dir));
234 235 236
    DBQueryFatal("delete from archive_views ".
		 "where view='$view' and archive_idx='$idx'")
	if (defined($idx));
Leigh B. Stoller's avatar
Leigh B. Stoller committed
237
    DBQueryFatal("delete from archives where idx='$idx'")
238 239 240 241 242
	if (defined($idx));
    return -1;
}

#
243
# Helper function for below; Checks that a path is safe and legal.
244
#
245
sub ValidatePath($)
246
{
247 248 249
    my ($ppath)  = @_;
    # We get a pointer so we can return the new path.
    my $pathname = $$ppath;
250
    my $rootdir;
251

252 253 254 255 256
    # Taint check path before handing off to shell below.
    if ($pathname =~ /^([-\w\/\.\+\@,~]+)$/) {
	$pathname = $1;
    }
    else {
257 258
	print STDERR "*** ValidatePath: illegal characters in '$pathname'\n";
	return 1;
259 260
    }

261
    if (! -e $pathname || ! -r $pathname) {
262 263
	print STDERR "*** ValidatePath: $pathname cannot be read!\n";
	return 1;
264 265 266
    }

    #
267 268
    # Use realpath to check that the path does not contain links to
    # files outside the directory space the user is allowed to access.
269
    # We must taint check the result to keep everyone happy.
270
    #
Leigh B. Stoller's avatar
Leigh B. Stoller committed
271
    my $realpath = `$REALPATH $pathname`;
272
    if ($realpath =~ /^([-\w\/\.\+\@,~]+)$/) {
273 274 275
	$realpath = $1;
    }
    else {
276
	print STDERR "*** ValidatePath: ".
277
	    "Bad data returned by realpath: $realpath\n";
278
	return -1;
279
    }
280

281
    #
282 283
    # Strip leading /dir from the pathname. We want a relative path to
    # the rootdir so we can copy it in.
284
    #
285
    if ($realpath =~ /^[\/]+(\w+)\/(.+)$/) {
286 287
	$rootdir  = $1;
	$pathname = $2;
288 289
    }
    else {
290 291
	print STDERR "*** ValidatePath: ".
	    "Illegal characters in pathname: $realpath\n";
292 293 294 295 296 297 298
	return -1;
    }

    #
    # The file must reside in one of the Emulab "root" filesystems.
    #
    if (! exists($ROOTS{$rootdir})) {
299
	print STDERR "*** ValidatePath: ".
300
	    "$realpath does not resolve to an allowed directory!\n";
301 302 303
	return -1;
    }

304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342
    $$ppath = $realpath;
    return 0;
}
    
#
# 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. 
#
sub ArchiveAdd($$;$$)
{
    my ($archive_idx, $pathname, $view, $exact) = @_;
    my $rootdir;

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

    $exact = 0
	if (!defined($exact));

    # This returns a taint checked value in $pathname.
    if (ValidatePath(\$pathname) != 0) {
	print STDERR "ArchiveAdd: Could not validate pathname $pathname\n";
	return -1;
    }

    #
    # Strip leading /dir from the pathname, we need it below.
    #
    if ($pathname =~ /^[\/]+(\w+)\/([-\w\/\.\+\@,~]+)$/) {
	$rootdir  = $1;
	$pathname = $2;
    }
    else {
	print STDERR "ArchiveAdd: Illegal characters in pathname $pathname\n";
	return -1;
    }

343 344 345 346 347
    #
    # See if the archive exists and if it does, get the pathname to it.
    #
    my $directory;
    if (GetArchiveDirectory($archive_idx, \$directory) < 0) {
348
	print STDERR "ArchiveAdd: ".
349 350 351 352
	    "Archive '$archive_idx' does not exist in the DB!\n";
	return -1;
    }
    if (! -d $directory || ! -w $directory) {
353
	print STDERR "ArchiveAdd: $directory cannot be written!\n";
354 355
	return -1;
    }
356
    my $repodir   = "$directory/repo";
357 358
    my $checkout  = "$directory/checkouts/$view";
    my $checkin   = "$directory/checkins/$view";
359 360
    
    #
Leigh B. Stoller's avatar
Leigh B. Stoller committed
361 362 363 364
    # 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). 
365
    #
366 367 368 369 370 371
    if (! -e "$checkin/$rootdir") {
	mysystem("$MKDIR $checkin/$rootdir") == 0 or return -1;
    }
    
    if (-f "/${rootdir}/${pathname}" || !$exact) {
	mysystem("$TAR cf - -C /$rootdir $pathname | ".
372 373
		 "$TAR xf - -U -C $checkin/$rootdir");
	mysystem("$CHMOD 775 $checkin/$rootdir/$pathname");
Leigh B. Stoller's avatar
Leigh B. Stoller committed
374 375
    }
    else {
376
	mysystem("cd /$rootdir; ".
377
		 "$RSYNC -R -rtgoDlz --delete ${pathname} $checkin/$rootdir");
378 379
    }
    if ($?) {
380
	print STDERR "ArchiveAdd: Could not copy in /$rootdir/$pathname\n";
381 382 383 384 385 386
	return -1;
    }
    return 0;
}

#
387 388 389 390 391
# 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.
392
#
Leigh B. Stoller's avatar
Leigh B. Stoller committed
393
sub ArchiveSavePoint($;$$$)
394
{
Leigh B. Stoller's avatar
Leigh B. Stoller committed
395
    my ($archive_idx, $savetag, $view, $altdir) = @_;
396 397 398 399 400 401 402 403
    my $cwd;

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

    return -1
	if (TBScriptLock("archive_${archive_idx}", 0, 120) !=
	    TBSCRIPTLOCK_OKAY());
404 405 406 407 408 409

    #
    # See if the archive exists and if it does, get the pathname to it.
    #
    my $directory;
    if (GetArchiveDirectory($archive_idx, \$directory) < 0) {
410
	print STDERR "ArchiveSavePoint: ".
411
	    "Archive '$archive_idx' does not exist in the DB!\n";
412
	goto bad;
413 414
    }
    if (! -d $directory || ! -w $directory) {
415
	print STDERR "ArchiveSavePoint: $directory cannot be written!\n";
416
	goto bad;
417
    }
418
    my $repodir   = "$directory/repo";
Leigh B. Stoller's avatar
Leigh B. Stoller committed
419
    my $checkin   = (defined($altdir) ? $altdir : "$directory/checkins/$view");
420 421 422 423 424 425

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

432
    # Get the current tag for the archive.
433 434
    my ($archive_tag);
    if (GetArchiveCurrentTags($archive_idx, $view, \$archive_tag) < 0) {
435 436 437 438 439 440 441 442 443 444 445 446 447 448
	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";
    }

449
    # Tags must start with a letter.
450 451 452 453
    if ($savetag =~ /^\d+/) {
	$savetag = "T" . $savetag;
    }
    
454
    #
455
    # Use svn import command. This is nice cause it handles all the
456 457 458
    # subdirs and stuff in one shot, instead of trying to deal with
    # each file and directory individually.
    #
459 460 461 462
    if (! chdir("$checkin")) {
	print STDERR "ArchiveSavePoint: Cannot chdir to $checkin!\n";
	goto bad;
    }
463
    mysystem("$IMPORTER -no_user_input file://$repodir ".
464 465
	     "          $view/savepoint . " .
	     ($debug < 2 ? "> /dev/null" : ""))
466 467 468 469 470
	== 0 or goto bad;

    #
    # Create the tag for this savepoint. 
    # 
471
    mysystem("$SVN copy $svnopt -m 'ArchiveCreate Branch' ".
472 473 474 475
	     "          file://$repodir/$view/savepoint ".
	     "          file://$repodir/$view/tags/${savetag}")
	== 0 or goto bad;
    
476 477 478 479

    #
    # And record the new tag. 
    # 
480
    DBQueryWarn("insert into archive_tags set idx=NULL, ".
481
		"  tag='$savetag', view='$view', ".
482
		"  archive_idx='$archive_idx', ".
483
		"  tagtype='$TAGTYPE_SAVEPOINT', ".
484
		"  date_created=UNIX_TIMESTAMP(now())") or goto bad;
485

486
  okay:
487 488 489
    TBScriptUnlock();
    chdir($cwd)
	if (defined($cwd));
490 491 492
    return 0;

  bad:
493 494 495
    TBScriptUnlock();
    chdir($cwd)
	if (defined($cwd));
496 497 498 499 500 501 502
    return -1;
}

#
# Commit the current contents of the temporary store to the archive.
# Returns -1 if any error. Otherwise return 0.
#
503
sub ArchiveCommit($;$$$$)
504
{
505
    my ($archive_idx, $newtag, $mfile, $view, $altdir) = @_;
506
    my $noactivity = 0;
507 508 509 510 511 512 513 514
    my $cwd;

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

    return -1
	if (TBScriptLock("archive_${archive_idx}", 0, 120) !=
	    TBSCRIPTLOCK_OKAY());
515 516 517 518 519 520 521 522

    #
    # 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";
523
	goto bad;
524 525 526
    }
    if (! -d $directory || ! -w $directory) {
	print STDERR "ArchiveCommit: $directory cannot be written!\n";
527
	goto bad;
528
    }
529
    my $repodir   = "$directory/repo";
530 531
    my $checkout  = "$directory/checkouts/$view";
    my $checkin   = (defined($altdir) ? $altdir : "$directory/checkins/$view");
532 533 534 535 536 537 538 539

    # 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
540
	print STDERR "ArchiveCommit: Bad data in $cwd!\n";
541
	goto bad;
542 543
    }

Leigh B. Stoller's avatar
Leigh B. Stoller committed
544 545
    if (! chdir("$directory")) {
	print STDERR "ArchiveCommit: Cannot chdir to $directory!\n";
546
	goto bad;
547 548 549
    }

    # Get the current tags for the archive.
550
    my ($archive_tag, $previous_tag);
551
    if (GetArchiveCurrentTags($archive_idx, $view, \$archive_tag,
552
			      \$previous_tag) < 0) {
553 554 555 556 557 558
	print STDERR "ArchiveCommit: ".
	    "Archive '$archive_idx' does not have a current tag!\n";
	goto bad;
    }

    #
559 560
    # Form new tag.
    # 
561 562 563
    my ($seconds, $microseconds) = gettimeofday();
    my $import_tag  = POSIX::strftime("T20%y%m%d-%H%M%S-", localtime());
    $import_tag    .= $microseconds;
564 565

    if (!defined($newtag)) {
566
	$newtag = $import_tag . "_commit";
567 568
    }

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

574 575 576 577 578 579 580
    #
    # 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 ".
581
		    "where archive_idx='$archive_idx' and view='$view' ".
582 583 584 585 586 587 588 589 590
		    "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;
    }
591 592 593 594 595 596 597 598 599 600 601 602 603

    #
    # Message can come from a file. 
    #
    my $message_arg = "-m 'Commit merge of ${archive_tag} to trunk'";

    if (defined($mfile)) {
	if (! -r $mfile) {
	    print STDERR "*** ArchiveCommit: $mfile cannot be read!\n";
	    goto bad;
	}
	$message_arg = "-F $mfile";
    }
604
    
605
    #
606 607 608
    # Okay, do the commit to the trunk for this view.
    # 
    if (! $noactivity) {
Leigh B. Stoller's avatar
Leigh B. Stoller committed
609 610 611 612 613 614 615 616 617
	#
	# Create a temporary spot to work in.
	# 
	if (! mkdir("merge.$$", 0777)) {
	    print STDERR "ArchiveCommit: Could not mkdir merge.$$: $!\n";
	    goto bad;
	}
	chdir("merge.$$");
	
618
	#
619
	# Check out the current trunk.
620
	#
621 622 623
	mysystem("$SVN checkout $svnopt file://$repodir/$view/trunk")
	    == 0 or goto bad;

624
	#
625 626 627 628 629 630 631 632 633 634
	# 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;
635

636
	mysystem("$SVN commit $svnopt $message_arg trunk")
637
	    == 0 or goto bad;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
638 639 640 641 642 643 644

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

647
    # Create a tag in the tags directory for the commit.
648
    mysystem("$SVN copy $svnopt $message_arg ".
649 650 651 652
	     "          file://$repodir/$view/trunk ".
	     "          file://$repodir/$view/tags/${newtag}")
	== 0 or goto bad;
    
Leigh B. Stoller's avatar
Leigh B. Stoller committed
653 654 655
    # 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.
656
    mysystem("$SVN copy $svnopt $message_arg ".
Leigh B. Stoller's avatar
Leigh B. Stoller committed
657 658 659 660
	     "          file://$repodir/$view/trunk ".
	     "          file://$repodir/$view/history/${newtag}")
	== 0 or goto bad;
    
661
    # Create a branch tag in the tags directory to base differences against.
662
    mysystem("$SVN copy $svnopt -m 'ArchiveCommit Branch' ".
663 664 665
	     "          file://$repodir/$view/trunk ".
	     "          file://$repodir/$view/tags/${newtag}-branch")
	== 0 or goto bad;
666 667 668 669

    # For putting message into DB.
    my $dclause = (defined($mfile) ? 
		   ", description=" . DBQuoteSpecial(`cat $mfile`) : "");
670
    
671
    DBQueryWarn("insert into archive_tags set idx=NULL, ".
672
		"  tag='$newtag', view='$view', ".
673
		"  archive_idx='$archive_idx', ".
674 675
		"  tagtype='$TAGTYPE_COMMIT', ".
		"  date_created=UNIX_TIMESTAMP(now()) $dclause")
676
	or goto bad;
677

678
    DBQueryWarn("update archive_views set ".
679
		"  current_tag='$newtag', ".
680
		"  previous_tag='$archive_tag' ".
681 682
		"where archive_idx='$archive_idx' and view='$view'")
	or goto bad;
683

684 685 686
    # And now into the checkout dir to checkout a current copy.
    if (! chdir("$checkout")) {
	print STDERR "ArchiveCommit: Cannot chdir to $checkout!\n";
687
	goto bad;
688
    }
689
    mysystem("$SVN $svnopt update trunk");
690
    if ($?) {
691
	print STDERR "ArchiveCommit: Could not update head revision!\n";
692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711
	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.
#
712
sub ArchiveFork($$;$$$)
713
{
714 715
    my ($archive_idx, $newview, $branchtag, $newtag, $view) = @_;
    my $sourcepoint;
716 717 718 719 720 721 722 723 724 725 726 727 728 729
    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) {
730
	print STDERR "ArchiveFork: ".
731 732 733 734
	    "Archive '$archive_idx' does not exist in the DB!\n";
	goto bad;
    }
    if (! -d $directory || ! -w $directory) {
735
	print STDERR "ArchiveFork: $directory cannot be written!\n";
736
	goto bad;
737
    }
738
    my $repodir     = "$directory/repo";
739 740 741 742 743 744 745 746 747 748 749 750 751
    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
752
	print STDERR "ArchiveFork: Bad data in $cwd!\n";
753 754 755 756
	goto bad;
    }

    # Get the current tags for the archive.
757
    my ($archive_tag, $previous_tag);
758
    if (GetArchiveCurrentTags($archive_idx, $view, \$archive_tag,
759
			      \$previous_tag) < 0) {
760
	print STDERR "ArchiveFork: ".
761 762 763 764
	    "Archive '$archive_idx' does not have a current tag!\n";
	goto bad;
    }

765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780
    #
    # 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;
    }

781 782
    # Create new view directories and checkout.
    if (! mkdir("$newcheckin", 0777)) {
783
	print STDERR "ArchiveFork: Could not mkdir $newcheckin: $!\n";
784 785 786
	goto bad;
    }
    if (! chmod(0777, "$newcheckin")) {
787
	print STDERR "ArchiveFork: Could not chmod $newcheckin: $!\n";
788 789
	goto bad;
    }
790 791

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

796 797 798 799 800 801 802 803 804 805 806 807
    #
    # If no branchtag supplied, we want to branch at the trunk. But we still
    # need to mark it with a tag or else we have no idea later what actually
    # happened.
    #
    if (!defined($branchtag)) {
	$branchtag = $import_tag . "_fork";

	mysystem("$SVN copy $svnopt -m 'ArchiveFork' ".
		 "          file://$repodir/$view/trunk ".
		 "          file://$repodir/$view/tags/$branchtag")
	    == 0 or goto bad;
808
    }
809
    $sourcepoint = "tags/$branchtag";
810 811 812 813 814 815 816

    # 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;

817 818 819 820 821 822 823
    # Ditto for the savepoints directory. 
    mysystem("$SVN copy $svnopt -m 'ArchiveFork' ".
	     "          file://$repodir/$view/savepoint ".
	     "          file://$repodir/$newview/savepoint")
	== 0 or goto bad;

    # Do not want to copy the tags/history directories. Add new ones.
824
    mysystem("$SVN mkdir $svnopt -m 'ArchiveFork' ".
825
	     "          file://$repodir/$newview/history ".
826 827 828
	     "          file://$repodir/$newview/tags")
	== 0 or goto bad;

829 830 831 832 833 834
    # Create a branch tag in the tags directory to base differences against.
    mysystem("$SVN copy $svnopt -m 'ArchiveFork Branch' ".
	     "          file://$repodir/$newview/trunk ".
	     "          file://$repodir/$newview/tags/${newtag}-branch")
	== 0 or goto bad;
    
835
    # Now check it out. This creates the checkouts/$newview directory.
836
    mysystem("cd $checkouts; ".
837
	     "$SVN checkout $svnopt file://$repodir/$newview")
838 839
	== 0 or goto bad;

840 841 842 843
    # Now enter the newview (okay, branch) of this archive.
    DBQueryWarn("insert into archive_views set ".
		"  current_tag='$newtag', archive_idx='$archive_idx', ".
		"  view='$newview', ".
844
		"  parent_view='$view', branch_tag='$branchtag', ".
845
		"  date_created=UNIX_TIMESTAMP(now())") or goto bad;
846
    
847 848 849
    # 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', ".
850
		"  tagtype='$TAGTYPE_INTERNAL', ".
851
		"  view='$newview', ".
852
		"  date_created=UNIX_TIMESTAMP(now())") or goto bad;
853

854
  okay:
855 856 857
    TBScriptUnlock();
    chdir($cwd)
	if (defined($cwd));
858
    return 0;
859 860

  bad:
861 862 863
    TBScriptUnlock();
    chdir($cwd)
	if (defined($cwd));
864
    return -1;
865 866
}

867 868 869
#
# Checkout a copy of the archive, optionally at a particular view/branch.
#
870
sub ArchiveCheckout($$;$$$)
871
{
872
    my ($archive_idx, $target, $view, $tag, $subdir) = @_;
873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930
    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"
    }
931 932 933
    # Allowed to check out a particular subdir (but not a file).
    $sourcepoint = $sourcepoint . "/$subdir"
	if (defined($subdir));
934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951

    # 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;
}

952 953 954 955 956 957 958 959 960 961 962 963 964 965 966
#
# 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) {
967
	print STDERR "ArchiveArchive: ".
968 969 970
	    "Archive '$archive_idx' does not exist in the DB!\n";
	return -1;
    }
971 972 973 974 975 976 977 978 979 980 981 982 983 984 985

    #
    # 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;
    }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
986 987 988 989 990 991 992 993 994 995 996

    # Is it shared? If so, certainly do not archive it!
    my $shared;
    if (IsArchiveShared($archive_idx, \$shared) < 0) {
	return -1;
    }
    if ($shared) {
	print STDERR "ArchiveArchive: ".
	    "Archive '$archive_idx' is shared; not archiving!\n";
	return 0;
    }
997
    
998
    if (! -d $directory || ! -w $directory) {
999
	print STDERR "ArchiveArchive: $directory cannot be written!\n";
1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017
	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.
    #
1018
    mysystem("$TAR cf - -C $directory repo | tar xf - -C $target");
1019 1020 1021 1022
    if ($?) {
	print STDERR "ArchiveArchive: Could not copy in $directory\n";
	return -1;
    }
1023 1024 1025 1026

    #
    # Update its location in the DB, and remove the old directory.
    # 
1027 1028 1029 1030
    DBQueryWarn("update archives set ".
		"   directory='$target', ".
		"   archived=1, ".
		"   date_archived=UNIX_TIMESTAMP(now()) ".
1031 1032 1033 1034 1035 1036 1037 1038 1039
		"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;
    }
1040 1041 1042 1043 1044 1045 1046
    return 0;
}

#
# Destroy an archive. The DB state is retained unless optional flag says
# to clean it.
#
1047
sub ArchiveDestroy($$;$)
1048
{
1049 1050 1051