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
    print STDERR "Running '$command'\n"
	if ($debug);
Leigh B. Stoller's avatar
Leigh B. Stoller committed
91
    my $retval = system($command);
92 93
    $ENV{'TMPDIR'} = $tmpdir
	if (defined($tmpdir));
Leigh B. Stoller's avatar
Leigh B. Stoller committed
94 95

    return $retval;
96 97
}

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

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

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

    $tag = $inittag
	if (!defined($tag));
126 127
    $view = $defaultview
	if (!defined($view));
128

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

339 340 341
    $special = 0
	if (!defined($special));

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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