libArchive.pm.in 55.8 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
# On or off
sub doarchiving($)
{
    my ($pid) = @_;
    
    return 1
	if ($USEARCHIVE && exists($ALLOWEDPID{$pid}));
    
    return 0;
}

80 81 82 83 84
# Little helper and debug function.
sub mysystem($)
{
    my ($command) = @_;

85 86 87 88
    # Need a big TMPDIR for svn stuff.
    my $tmpdir = $ENV{'TMPDIR'};
    $ENV{'TMPDIR'} = "/usr/testbed/tmp";

89 90 91
    print STDERR "Running '$command'\n"
	if ($debug);
    system($command);
92 93
    $ENV{'TMPDIR'} = $tmpdir
	if (defined($tmpdir));
94 95
}

96 97 98 99 100 101
# Another little helper for scripts that include this library.
sub setdebug($)
{
    my ($toggle) = @_;

    if ($toggle) {
102
	$debug  = $toggle;
103 104 105 106 107 108 109 110
	$svnopt = "";
    }
    else {
	$debug  = 0;
	$svnopt = "-q";
    }
}

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

    $tag = $inittag
	if (!defined($tag));
124 125
    $view = $defaultview
	if (!defined($view));
126

127
    # Tags cannot must start with a letter.
128 129 130
    if ($tag =~ /^\d+/) {
	$tag = "T" . $tag;
    }
131 132 133 134 135

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

Leigh B. Stoller's avatar
Leigh B. Stoller committed
156
    DBQueryWarn("update archives set directory='$dir' where idx='$idx'")
157 158 159
	or goto bad;

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

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

    # Create a branch tag in the tags directory to base differences against.
213
    mysystem("$SVN copy $svnopt -m 'ArchiveCreate Branch' ".
214 215
	     "          file://$repodir/$view/trunk ".
	     "          file://$repodir/$view/tags/${tag}-branch")
216
	== 0 or goto bad;
217 218 219 220 221 222 223 224

    # 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;
225
    
226 227
    # Now check it out. This creates the $checkouts/$view directory.
    mysystem("cd $checkouts; ".
228
	     "$SVN checkout $svnopt file://$repodir/$view")
229 230
	== 0 or goto bad;

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

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

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

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

274
    if (! -e $pathname || ! -r $pathname) {
275 276
	print STDERR "*** ValidatePath: $pathname cannot be read!\n";
	return 1;
277 278 279
    }

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

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

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

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

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

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

337 338 339
    $special = 0
	if (!defined($special));

340 341 342 343 344 345 346 347 348
    # 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.
    #
349 350 351 352 353
    my ($rootdir, $sourcedir, $sourcefile);
    my $rsyncopt = "";
    
    if ($special) {
	#
354 355 356 357 358 359
	# 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.
360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375
	#
	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";
376 377 378 379 380 381
    }
    else {
	print STDERR "ArchiveAdd: Illegal characters in pathname $pathname\n";
	return -1;
    }

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

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

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

    return -1
	if (TBScriptLock("archive_${archive_idx}", 0, 120) !=
	    TBSCRIPTLOCK_OKAY());
443 444 445 446 447 448

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

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

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

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

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

    #
    # And record the new tag. 
    # 
520
    DBQueryWarn("insert into archive_tags set idx=NULL, ".
521
		"  tag='$savetag', view='$view', ".
522
		"  archive_idx='$archive_idx', ".
523
		"  tagtype='$TAGTYPE_SAVEPOINT', ".
524
		"  date_created=UNIX_TIMESTAMP(now())") or goto bad;
525

526
  okay:
527 528 529
    TBScriptUnlock();
    chdir($cwd)
	if (defined($cwd));
530 531 532
    return 0;

  bad:
533 534 535
    TBScriptUnlock();
    chdir($cwd)
	if (defined($cwd));
536 537 538 539 540 541 542
    return -1;
}

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

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

    return -1
	if (TBScriptLock("archive_${archive_idx}", 0, 120) !=
	    TBSCRIPTLOCK_OKAY());
555 556 557 558 559 560 561 562

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

    # 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
580
	print STDERR "ArchiveCommit: Bad data in $cwd!\n";
581
	goto bad;
582 583
    }

Leigh B. Stoller's avatar
Leigh B. Stoller committed
584 585
    if (! chdir("$directory")) {
	print STDERR "ArchiveCommit: Cannot chdir to $directory!\n";
586
	goto bad;
587 588 589
    }

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

    #
599 600
    # Form new tag.
    # 
601 602 603
    my ($seconds, $microseconds) = gettimeofday();
    my $import_tag  = POSIX::strftime("T20%y%m%d-%H%M%S-", localtime());
    $import_tag    .= $microseconds;
604 605

    if (!defined($newtag)) {
606
	$newtag = $import_tag . "_commit";
607 608
    }

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

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

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

664
	#
665 666 667 668 669 670 671 672 673 674
	# 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;
675

676
	mysystem("$SVN commit $svnopt $message_arg trunk")
677
	    == 0 or goto bad;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
678 679 680 681 682 683 684

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

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

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

718
    DBQueryWarn("update archive_views set ".
719
		"  current_tag='$newtag', ".
720
		"  previous_tag='$archive_tag' ".
721 722
		"where archive_idx='$archive_idx' and view='$view'")
	or goto bad;
723

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

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

805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820
    #
    # 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;
    }

821 822
    # Create new view directories and checkout.
    if (! mkdir("$newcheckin", 0777)) {
823
	print STDERR "ArchiveFork: Could not mkdir $newcheckin: $!\n";
824 825 826
	goto bad;
    }
    if (! chmod(0777, "$newcheckin")) {
827
	print STDERR "ArchiveFork: Could not chmod $newcheckin: $!\n";
828 829
	goto bad;
    }
830 831

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

836 837 838 839 840 841 842 843 844 845 846 847
    #
    # 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;
848
    }
849
    $sourcepoint = "tags/$branchtag";
850 851 852 853 854 855 856

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

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

869 870 871 872 873
    # 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;
874 875 876 877 878 879 880 881

    # 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;
882
    
883
    # Now check it out. This creates the checkouts/$newview directory.
884
    mysystem("cd $checkouts; ".
885
	     "$SVN checkout $svnopt file://$repodir/$newview")
886 887
	== 0 or goto bad;

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

902
  okay:
903 904 905
    TBScriptUnlock();
    chdir($cwd)
	if (defined($cwd));
906
    return 0;
907 908

  bad:
909 910 911
    TBScriptUnlock();
    chdir($cwd)
	if (defined($cwd));
912
    return -1;
913 914
}

915 916 917
#
# Checkout a copy of the archive, optionally at a particular view/branch.
#
918
sub ArchiveCheckout($$;$$$)
919
{
920
    my ($archive_idx, $target, $view, $tag, $subdir) = @_;
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 974 975 976 977 978
    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"
    }
979 980 981
    # Allowed to check out a particular subdir (but not a file).
    $sourcepoint = $sourcepoint . "/$subdir"
	if (defined($subdir));
982

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

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

1001 1002 1003 1004 1005
#
# 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.
#
1006
sub ArchiveArchive($)
1007
{
1008 1009