libArchive.pm.in 55.6 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
my $ARCHSUPPORT = @ARCHIVESUPPORT@;
my $USEARCHIVE  = ($MAINSITE || $ARCHSUPPORT);
33
my %ALLOWEDPID  = ("testbed" => 1, "compadres" => 1, "tbres" => 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 215 216 217 218 219

    # 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.
    mysystem("$SVN copy $svnopt -m 'ArchiveCreate' ".
	     "          file://$repodir/$view/trunk ".
	     "          file://$repodir/$view/history/${tag}")
	== 0 or goto bad;
220
    
221 222
    # Now check it out. This creates the $checkouts/$view directory.
    mysystem("cd $checkouts; ".
223
	     "$SVN checkout $svnopt file://$repodir/$view")
224 225
	== 0 or goto bad;

226 227 228 229 230
    # 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;
    
231
    # Now enter an initial tag for the tree. Nothing actually gets tagged.
232 233
    DBQueryWarn("insert into archive_tags set idx=NULL, ".
		"  tag='$tag', archive_idx='$idx', view='$view', ".
234
		"  tagtype='$TAGTYPE_INTERNAL', ".
235 236 237 238 239 240 241
		"  date_created=UNIX_TIMESTAMP(now())") or goto bad;
    
    return $idx;

  bad:
#    mysystem("$RM -rf $dir")
#        if (defined($dir));
242 243 244
    DBQueryFatal("delete from archive_views ".
		 "where view='$view' and archive_idx='$idx'")
	if (defined($idx));
Leigh B. Stoller's avatar
Leigh B. Stoller committed
245
    DBQueryFatal("delete from archives where idx='$idx'")
246 247 248 249 250
	if (defined($idx));
    return -1;
}

#
251
# Helper function for below; Checks that a path is safe and legal.
252
#
253
sub ValidatePath($)
254
{
255 256 257
    my ($ppath)  = @_;
    # We get a pointer so we can return the new path.
    my $pathname = $$ppath;
258
    my $rootdir;
259

260 261 262 263 264
    # Taint check path before handing off to shell below.
    if ($pathname =~ /^([-\w\/\.\+\@,~]+)$/) {
	$pathname = $1;
    }
    else {
265 266
	print STDERR "*** ValidatePath: illegal characters in '$pathname'\n";
	return 1;
267 268
    }

269
    if (! -e $pathname || ! -r $pathname) {
270 271
	print STDERR "*** ValidatePath: $pathname cannot be read!\n";
	return 1;
272 273 274
    }

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

289
    #
290 291
    # Strip leading /dir from the pathname. We want a relative path to
    # the rootdir so we can copy it in.
292
    #
293
    if ($realpath =~ /^[\/]+(\w+)\/(.+)$/) {
294 295
	$rootdir  = $1;
	$pathname = $2;
296 297
    }
    else {
298 299
	print STDERR "*** ValidatePath: ".
	    "Illegal characters in pathname: $realpath\n";
300 301 302 303 304 305 306
	return -1;
    }

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

312 313 314 315 316 317 318 319 320 321
    $$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. 
#
322
sub ArchiveAdd($$;$$$)
323
{
324
    my ($archive_idx, $pathname, $view, $exact, $special) = @_;
325 326 327 328 329 330 331

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

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

332 333 334
    $special = 0
	if (!defined($special));

335 336 337 338 339 340 341 342 343
    # 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.
    #
344 345 346 347 348
    my ($rootdir, $sourcedir, $sourcefile);
    my $rsyncopt = "";
    
    if ($special) {
	#
349 350 351 352 353 354
	# What does this do? 
	# Basically, we copy the last part (directory) to / of the checkin.
	# eg: cp /proj/pid/exp/eid/archive/... /archive of the checkins.
	# This avoids pid/eid tokens in the archive.
	#
	# Last part of path must be a directory.
355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370
	#
	if (! -d $pathname) {
	    print STDERR "ArchiveAdd: Must be a direcotory: $pathname\n";
	    return -1;
	}
	my ($filename,$directory,undef) = fileparse($pathname);

	$rootdir    = $filename;
	$sourcedir  = $directory;
	$sourcefile = $filename . "/";
    }
    elsif ($pathname =~ /^[\/]+(\w+)\/([-\w\/\.\+\@,~]+)$/) {
	$rootdir    = $1;
	$sourcedir  = $1;
	$sourcefile = $2;
	$rsyncopt   = "-R";
371 372 373 374 375 376
    }
    else {
	print STDERR "ArchiveAdd: Illegal characters in pathname $pathname\n";
	return -1;
    }

377 378 379 380 381
    #
    # See if the archive exists and if it does, get the pathname to it.
    #
    my $directory;
    if (GetArchiveDirectory($archive_idx, \$directory) < 0) {
382
	print STDERR "ArchiveAdd: ".
383 384 385 386
	    "Archive '$archive_idx' does not exist in the DB!\n";
	return -1;
    }
    if (! -d $directory || ! -w $directory) {
387
	print STDERR "ArchiveAdd: $directory cannot be written!\n";
388 389
	return -1;
    }
390
    my $repodir   = "$directory/repo";
391
    my $checkin   = "$directory/checkins/$view";
392 393
    
    #
Leigh B. Stoller's avatar
Leigh B. Stoller committed
394 395 396 397
    # 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). 
398
    #
399 400 401 402
    if (! -e "$checkin/$rootdir") {
	mysystem("$MKDIR $checkin/$rootdir") == 0 or return -1;
    }
    
403 404
    if (-f "/${sourcedir}/${sourcefile}" || !$exact) {
	mysystem("$TAR cf - -C /$sourcedir $sourcefile | ".
405
		 "$TAR xf - -U -C $checkin/$rootdir");
406
	mysystem("$CHMOD 775 $checkin/$rootdir/$sourcefile");
Leigh B. Stoller's avatar
Leigh B. Stoller committed
407 408
    }
    else {
409 410 411
	mysystem("cd /$sourcedir; ".
		 "$RSYNC $rsyncopt -rtgoDlz ".
		 "  --delete ${sourcefile} $checkin/$rootdir");
412 413
    }
    if ($?) {
414
	print STDERR "ArchiveAdd: Could not copy in $pathname\n";
415 416 417 418 419 420
	return -1;
    }
    return 0;
}

#
421 422 423 424 425
# 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.
426
#
Leigh B. Stoller's avatar
Leigh B. Stoller committed
427
sub ArchiveSavePoint($;$$$)
428
{
Leigh B. Stoller's avatar
Leigh B. Stoller committed
429
    my ($archive_idx, $savetag, $view, $altdir) = @_;
430 431 432 433 434 435 436 437
    my $cwd;

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

    return -1
	if (TBScriptLock("archive_${archive_idx}", 0, 120) !=
	    TBSCRIPTLOCK_OKAY());
438 439 440 441 442 443

    #
    # See if the archive exists and if it does, get the pathname to it.
    #
    my $directory;
    if (GetArchiveDirectory($archive_idx, \$directory) < 0) {
444
	print STDERR "ArchiveSavePoint: ".
445
	    "Archive '$archive_idx' does not exist in the DB!\n";
446
	goto bad;
447 448
    }
    if (! -d $directory || ! -w $directory) {
449
	print STDERR "ArchiveSavePoint: $directory cannot be written!\n";
450
	goto bad;
451
    }
452
    my $repodir   = "$directory/repo";
Leigh B. Stoller's avatar
Leigh B. Stoller committed
453
    my $checkin   = (defined($altdir) ? $altdir : "$directory/checkins/$view");
454 455 456 457 458 459

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

466
    # Get the current tag for the archive.
467 468
    my ($archive_tag);
    if (GetArchiveCurrentTags($archive_idx, $view, \$archive_tag) < 0) {
469 470 471 472 473 474 475 476 477 478 479 480 481 482
	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";
    }

483
    # Tags must start with a letter.
484 485 486 487
    if ($savetag =~ /^\d+/) {
	$savetag = "T" . $savetag;
    }
    
488
    #
489
    # Use svn import command. This is nice cause it handles all the
490 491 492
    # subdirs and stuff in one shot, instead of trying to deal with
    # each file and directory individually.
    #
493 494 495 496
    if (! chdir("$checkin")) {
	print STDERR "ArchiveSavePoint: Cannot chdir to $checkin!\n";
	goto bad;
    }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
497 498 499
    # Avoid a core file from svn.
    mysystem("ulimit -c 0; $IMPORTER -no_user_input file://$repodir ".
	     "                 $view/savepoint . " .
500
	     ($debug < 2 ? "> /dev/null 2>&1" : ""))
501 502 503 504 505
	== 0 or goto bad;

    #
    # Create the tag for this savepoint. 
    # 
506
    mysystem("$SVN copy $svnopt -m 'ArchiveCreate Branch' ".
507 508 509 510
	     "          file://$repodir/$view/savepoint ".
	     "          file://$repodir/$view/tags/${savetag}")
	== 0 or goto bad;
    
511 512 513 514

    #
    # And record the new tag. 
    # 
515
    DBQueryWarn("insert into archive_tags set idx=NULL, ".
516
		"  tag='$savetag', view='$view', ".
517
		"  archive_idx='$archive_idx', ".
518
		"  tagtype='$TAGTYPE_SAVEPOINT', ".
519
		"  date_created=UNIX_TIMESTAMP(now())") or goto bad;
520

521
  okay:
522 523 524
    TBScriptUnlock();
    chdir($cwd)
	if (defined($cwd));
525 526 527
    return 0;

  bad:
528 529 530
    TBScriptUnlock();
    chdir($cwd)
	if (defined($cwd));
531 532 533 534 535 536 537
    return -1;
}

#
# Commit the current contents of the temporary store to the archive.
# Returns -1 if any error. Otherwise return 0.
#
538
sub ArchiveCommit($;$$$$)
539
{
540
    my ($archive_idx, $newtag, $mfile, $view, $altdir) = @_;
541
    my $noactivity = 0;
542 543 544 545 546 547 548 549
    my $cwd;

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

    return -1
	if (TBScriptLock("archive_${archive_idx}", 0, 120) !=
	    TBSCRIPTLOCK_OKAY());
550 551 552 553 554 555 556 557

    #
    # 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";
558
	goto bad;
559 560 561
    }
    if (! -d $directory || ! -w $directory) {
	print STDERR "ArchiveCommit: $directory cannot be written!\n";
562
	goto bad;
563
    }
564
    my $repodir   = "$directory/repo";
565 566
    my $checkout  = "$directory/checkouts/$view";
    my $checkin   = (defined($altdir) ? $altdir : "$directory/checkins/$view");
567 568 569 570 571 572 573 574

    # 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
575
	print STDERR "ArchiveCommit: Bad data in $cwd!\n";
576
	goto bad;
577 578
    }

Leigh B. Stoller's avatar
Leigh B. Stoller committed
579 580
    if (! chdir("$directory")) {
	print STDERR "ArchiveCommit: Cannot chdir to $directory!\n";
581
	goto bad;
582 583 584
    }

    # Get the current tags for the archive.
585
    my ($archive_tag, $previous_tag);
586
    if (GetArchiveCurrentTags($archive_idx, $view, \$archive_tag,
587
			      \$previous_tag) < 0) {
588 589 590 591 592 593
	print STDERR "ArchiveCommit: ".
	    "Archive '$archive_idx' does not have a current tag!\n";
	goto bad;
    }

    #
594 595
    # Form new tag.
    # 
596 597 598
    my ($seconds, $microseconds) = gettimeofday();
    my $import_tag  = POSIX::strftime("T20%y%m%d-%H%M%S-", localtime());
    $import_tag    .= $microseconds;
599 600

    if (!defined($newtag)) {
601
	$newtag = $import_tag . "_commit";
602 603
    }

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

609 610 611 612 613 614 615
    #
    # 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 ".
616
		    "where archive_idx='$archive_idx' and view='$view' ".
617 618 619 620 621 622 623 624 625
		    "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;
    }
626 627 628 629 630 631 632 633 634 635 636 637 638

    #
    # 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";
    }
639
    
640
    #
641 642 643
    # Okay, do the commit to the trunk for this view.
    # 
    if (! $noactivity) {
Leigh B. Stoller's avatar
Leigh B. Stoller committed
644 645 646 647 648 649 650 651 652
	#
	# Create a temporary spot to work in.
	# 
	if (! mkdir("merge.$$", 0777)) {
	    print STDERR "ArchiveCommit: Could not mkdir merge.$$: $!\n";
	    goto bad;
	}
	chdir("merge.$$");
	
653
	#
654
	# Check out the current trunk.
655
	#
656 657 658
	mysystem("$SVN checkout $svnopt file://$repodir/$view/trunk")
	    == 0 or goto bad;

659
	#
660 661 662 663 664 665 666 667 668 669
	# 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;
670

671
	mysystem("$SVN commit $svnopt $message_arg trunk")
672
	    == 0 or goto bad;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
673 674 675 676 677 678 679

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

682
    # Create a tag in the tags directory for the commit.
683
    mysystem("$SVN copy $svnopt $message_arg ".
684 685 686 687
	     "          file://$repodir/$view/trunk ".
	     "          file://$repodir/$view/tags/${newtag}")
	== 0 or goto bad;
    
Leigh B. Stoller's avatar
Leigh B. Stoller committed
688 689 690
    # 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.
691
    mysystem("$SVN copy $svnopt $message_arg ".
Leigh B. Stoller's avatar
Leigh B. Stoller committed
692 693 694 695
	     "          file://$repodir/$view/trunk ".
	     "          file://$repodir/$view/history/${newtag}")
	== 0 or goto bad;
    
696
    # Create a branch tag in the tags directory to base differences against.
697
    mysystem("$SVN copy $svnopt -m 'ArchiveCommit Branch' ".
698 699 700
	     "          file://$repodir/$view/trunk ".
	     "          file://$repodir/$view/tags/${newtag}-branch")
	== 0 or goto bad;
701 702 703 704

    # For putting message into DB.
    my $dclause = (defined($mfile) ? 
		   ", description=" . DBQuoteSpecial(`cat $mfile`) : "");
705
    
706
    DBQueryWarn("insert into archive_tags set idx=NULL, ".
707
		"  tag='$newtag', view='$view', ".
708
		"  archive_idx='$archive_idx', ".
709 710
		"  tagtype='$TAGTYPE_COMMIT', ".
		"  date_created=UNIX_TIMESTAMP(now()) $dclause")
711
	or goto bad;
712

713
    DBQueryWarn("update archive_views set ".
714
		"  current_tag='$newtag', ".
715
		"  previous_tag='$archive_tag' ".
716 717
		"where archive_idx='$archive_idx' and view='$view'")
	or goto bad;
718

719 720 721
    # And now into the checkout dir to checkout a current copy.
    if (! chdir("$checkout")) {
	print STDERR "ArchiveCommit: Cannot chdir to $checkout!\n";
722
	goto bad;
723
    }
724
    mysystem("$SVN $svnopt update trunk");
725
    if ($?) {
726
	print STDERR "ArchiveCommit: Could not update head revision!\n";
727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746
	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.
#
747
sub ArchiveFork($$;$$$)
748
{
749 750
    my ($archive_idx, $newview, $branchtag, $newtag, $view) = @_;
    my $sourcepoint;
751 752 753 754 755 756 757 758 759 760 761 762 763 764
    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) {
765
	print STDERR "ArchiveFork: ".
766 767 768 769
	    "Archive '$archive_idx' does not exist in the DB!\n";
	goto bad;
    }
    if (! -d $directory || ! -w $directory) {
770
	print STDERR "ArchiveFork: $directory cannot be written!\n";
771
	goto bad;
772
    }
773
    my $repodir     = "$directory/repo";
774 775 776 777 778 779 780 781 782 783 784 785 786
    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
787
	print STDERR "ArchiveFork: Bad data in $cwd!\n";
788 789 790 791
	goto bad;
    }

    # Get the current tags for the archive.
792
    my ($archive_tag, $previous_tag);
793
    if (GetArchiveCurrentTags($archive_idx, $view, \$archive_tag,
794
			      \$previous_tag) < 0) {
795
	print STDERR "ArchiveFork: ".
796 797 798 799
	    "Archive '$archive_idx' does not have a current tag!\n";
	goto bad;
    }

800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815
    #
    # 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;
    }

816 817
    # Create new view directories and checkout.
    if (! mkdir("$newcheckin", 0777)) {
818
	print STDERR "ArchiveFork: Could not mkdir $newcheckin: $!\n";
819 820 821
	goto bad;
    }
    if (! chmod(0777, "$newcheckin")) {
822
	print STDERR "ArchiveFork: Could not chmod $newcheckin: $!\n";
823 824
	goto bad;
    }
825 826

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

831 832 833 834 835 836 837 838 839 840 841 842
    #
    # 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;
843
    }
844
    $sourcepoint = "tags/$branchtag";
845 846 847 848 849 850 851

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

852 853 854 855 856 857 858
    # 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.
859
    mysystem("$SVN mkdir $svnopt -m 'ArchiveFork' ".
860
	     "          file://$repodir/$newview/history ".
861 862 863
	     "          file://$repodir/$newview/tags")
	== 0 or goto bad;

864 865 866 867 868
    # 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;
869 870 871 872 873 874 875 876

    # 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.
    mysystem("$SVN copy $svnopt -m 'ArchiveFork Branch' ".
	     "          file://$repodir/$newview/trunk ".
	     "          file://$repodir/$newview/history/${newtag}")
	== 0 or goto bad;
877
    
878
    # Now check it out. This creates the checkouts/$newview directory.
879
    mysystem("cd $checkouts; ".
880
	     "$SVN checkout $svnopt file://$repodir/$newview")
881 882
	== 0 or goto bad;

883 884 885 886
    # Now enter the newview (okay, branch) of this archive.
    DBQueryWarn("insert into archive_views set ".
		"  current_tag='$newtag', archive_idx='$archive_idx', ".
		"  view='$newview', ".
887
		"  parent_view='$view', branch_tag='$branchtag', ".
888
		"  date_created=UNIX_TIMESTAMP(now())") or goto bad;
889
    
890 891 892
    # 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', ".
893
		"  tagtype='$TAGTYPE_INTERNAL', ".
894
		"  view='$newview', ".
895
		"  date_created=UNIX_TIMESTAMP(now())") or goto bad;
896

897
  okay:
898 899 900
    TBScriptUnlock();
    chdir($cwd)
	if (defined($cwd));
901
    return 0;
902 903

  bad:
904 905 906
    TBScriptUnlock();
    chdir($cwd)
	if (defined($cwd));
907
    return -1;
908 909
}

910 911 912
#
# Checkout a copy of the archive, optionally at a particular view/branch.
#
913
sub ArchiveCheckout($$;$$$)
914
{
915
    my ($archive_idx, $target, $view, $tag, $subdir) = @_;
916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973
    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"
    }
974 975 976
    # Allowed to check out a particular subdir (but not a file).
    $sourcepoint = $sourcepoint . "/$subdir"
	if (defined($subdir));
977

978
    # Now check it out, although we actually use export to avoid .svn files.
979
    mysystem("cd $target; ".
980 981
	     "$SVN export $svnopt ".
	     "    --force file://$repodir/$view/$sourcepoint .")
982 983 984 985 986 987 988 989 990 991 992 993 994 995
	== 0 or goto bad;
  okay:
    TBScriptUnlock();
    chdir($cwd)
	if (defined($cwd));
    return 0;

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

996 997 998 999 1000
#
# 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.
#
1001
sub ArchiveArchive($)
1002
{
1003 1004
    my ($archive_idx) = @_;
    my $target = "$ARCHIVEDIR/Archive/$archive_idx";
1005 1006 1007 1008 1009 1010

    #
    # See if the archive exists and if it does, get the pathname to it.
    #
    my $directory;
    if (GetArchiveDirectory($archive_idx, \$directory) < 0) {
1011
	print STDERR "ArchiveArchive: ".
1012