libArchive.pm.in 50 KB
Newer Older
1 2 3
#!/usr/bin/perl -wT
#
# EMULAB-COPYRIGHT
Timothy Stack's avatar
Timothy Stack committed
4
# Copyright (c) 2005, 2006 University of Utah and the Flux Group.
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
# All rights reserved.
#
# XXX Need to deal with locking at some point ...
#
package libArchive;

use strict;
use Exporter;
use vars qw(@ISA @EXPORT);

@ISA    = "Exporter";
@EXPORT = qw ( );

# Must come after package declaration!
use lib '@prefix@/lib';
use libdb;
21
use libtestbed;
22 23 24 25 26 27 28 29
use English;
use File::stat;
use File::Basename;
use POSIX qw(strftime);
use Time::HiRes qw(gettimeofday);

# Configure variables
my $TB		= "@prefix@";
Leigh B. Stoller's avatar
Leigh B. Stoller committed
30 31
my $MAINSITE    = @TBMAINSITE@;
my $ALLOWEDPID  = "testbed";
32 33 34 35 36 37 38 39
# XXX
my $ARCHIVEDIR  = "/usr/testbed/exparchive";
my $TESTMODE    = @TESTMODE@;
my $TBOPS       = "@TBOPSEMAIL@";
my $ELABINELAB  = @ELABINELAB@;
my $MD5		= "/sbin/md5";
my $MKDIR       = "/bin/mkdir";
my $CHMOD       = "/bin/chmod";
40
my $CHGRP       = "/usr/bin/chgrp";
41
my $TAR		= "/usr/bin/tar";
Leigh B. Stoller's avatar
Leigh B. Stoller committed
42
my $RSYNC	= "/usr/local/bin/rsync";
43
my $RM		= "/bin/rm";
Leigh B. Stoller's avatar
Leigh B. Stoller committed
44
my $REALPATH	= "/bin/realpath";
45 46 47
my $SVN         = "/usr/local/bin/svn";
my $SVNADMIN    = "/usr/local/bin/svnadmin";
my $IMPORTER    = "$TB/sbin/svn_load_dirs.pl";
48
my $inittag     = 'root';
49
my $defaultview = 'head';
50
my $debug       = 0;
51
my $svnopt      = ($debug ? "" : "-q");
52 53 54 55
my %ROOTS       = ("proj"   => "proj",
		   "users"  => "users",
		   "share"  => "share",
		   "groups" => "groups");
56

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

62 63 64 65 66 67 68 69 70 71
# Little helper and debug function.
sub mysystem($)
{
    my ($command) = @_;

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

72 73 74 75 76 77 78 79 80 81 82 83 84 85 86
# Another little helper for scripts that include this library.
sub setdebug($)
{
    my ($toggle) = @_;

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

87 88 89 90
#
# Create a new archive. Returns -1 if any error. Otherwise return
# the new record index.
# 
91
sub ArchiveCreate(;$$$)
92
{
93
    my ($tag, $view, $unix_gid) = @_;
94
    
95 96
    my $idx;
    my $dir;
97 98 99

    $tag = $inittag
	if (!defined($tag));
100 101
    $view = $defaultview
	if (!defined($view));
102

103
    # Tags cannot must start with a letter.
104 105 106
    if ($tag =~ /^\d+/) {
	$tag = "T" . $tag;
    }
107 108 109 110 111

    #
    # Need to create the directory for it, once we have the index.
    # 
    my $query_result =
Leigh B. Stoller's avatar
Leigh B. Stoller committed
112
	DBQueryWarn("insert into archives set ".
113
		    "  idx=NULL, ".
114 115 116 117 118 119 120 121 122 123 124 125 126 127
		    "  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;
128 129 130
    if (defined($unix_gid)) {
	mysystem("$CHGRP $unix_gid $dir") == 0 or goto bad;
    }
131

Leigh B. Stoller's avatar
Leigh B. Stoller committed
132
    DBQueryWarn("update archives set directory='$dir' where idx='$idx'")
133 134 135
	or goto bad;

    #
136
    # Make subdirs. One to hold the control tree, and the other
137 138
    # to hold currently checked out versions of the tree. Lastly, we
    # need a place to copyin files before they are added to the repo.
139
    #
140
    my $repodir   = "$dir/repo";
141 142
    my $checkouts = "$dir/checkouts";
    my $checkins  = "$dir/checkins";
143

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

    # Create a branch tag in the tags directory to base differences against.
189
    mysystem("$SVN copy $svnopt -m 'ArchiveCreate Branch' ".
190 191
	     "          file://$repodir/$view/trunk ".
	     "          file://$repodir/$view/tags/${tag}-branch")
192
	== 0 or goto bad;
193
    
194 195
    # Now check it out. This creates the $checkouts/$view directory.
    mysystem("cd $checkouts; ".
196
	     "$SVN checkout $svnopt file://$repodir/$view")
197 198
	== 0 or goto bad;

199 200 201 202 203
    # 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;
    
204
    # Now enter an initial tag for the tree. Nothing actually gets tagged.
205 206
    DBQueryWarn("insert into archive_tags set idx=NULL, ".
		"  tag='$tag', archive_idx='$idx', view='$view', ".
207
		"  tagtype='$TAGTYPE_INTERNAL', ".
208 209 210 211 212 213 214
		"  date_created=UNIX_TIMESTAMP(now())") or goto bad;
    
    return $idx;

  bad:
#    mysystem("$RM -rf $dir")
#        if (defined($dir));
215 216 217
    DBQueryFatal("delete from archive_views ".
		 "where view='$view' and archive_idx='$idx'")
	if (defined($idx));
Leigh B. Stoller's avatar
Leigh B. Stoller committed
218
    DBQueryFatal("delete from archives where idx='$idx'")
219 220 221 222 223 224 225 226 227 228
	if (defined($idx));
    return -1;
}

#
# Add a file to an archive. Returns -1 if any error. Otherwise return 0.
# All this does is copy the file (and its directory structure) into the
# temporary store. Later, after all the files are in the tree, must
# commit it to the repo. 
#
Leigh B. Stoller's avatar
Leigh B. Stoller committed
229
sub ArchiveAdd($$;$$)
230
{
Leigh B. Stoller's avatar
Leigh B. Stoller committed
231
    my ($archive_idx, $pathname, $view, $exact) = @_;
232
    my $rootdir;
233 234 235

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

Leigh B. Stoller's avatar
Leigh B. Stoller committed
237 238 239
    $exact = 0
	if (!defined($exact));

240 241 242 243 244 245 246 247 248
    # Taint check path before handing off to shell below.
    if ($pathname =~ /^([-\w\/\.\+\@,~]+)$/) {
	$pathname = $1;
    }
    else {
	print STDERR "ArchiveAdd: ".
	    "Illegal characters in: $pathname\n";
    }

249
    if (! -e $pathname || ! -r $pathname) {
250
	print STDERR "*** ArchiveAdd: $pathname cannot be read!\n";
251
	return 0;
252 253 254
    }

    #
255 256
    # Use realpath to check that the path does not contain links to
    # files outside the directory space the user is allowed to access.
257
    #
Leigh B. Stoller's avatar
Leigh B. Stoller committed
258
    my $realpath = `$REALPATH $pathname`;
259
    if ($realpath =~ /^([-\w\/\.\+\@,~]+)$/) {
260 261 262
	$realpath = $1;
    }
    else {
263
	print STDERR "ArchiveAdd: ".
264 265
	    "Bad data returned by realpath: $realpath\n";
    }
266

267
    #
268 269
    # Strip leading /dir from the pathname, and taint check it. We want
    # a relative path to the rootdiir so we can copy it in. 
270
    #
271 272 273
    if ($realpath =~ /^[\/]+(\w+)\/([-\w\/\.\+\@,~]+)$/) {
	$rootdir  = $1;
	$pathname = $2;
274 275
    }
    else {
276 277 278 279 280 281 282 283 284 285
	print STDERR "ArchiveAdd: Illegal characters in pathname $pathname\n";
	return -1;
    }

    #
    # The file must reside in one of the Emulab "root" filesystems.
    #
    if (! exists($ROOTS{$rootdir})) {
	print STDERR "ArchiveAdd: ".
	    "$realpath does not resolve to an allowed directory!\n";
286 287 288 289 290 291 292 293
	return -1;
    }

    #
    # See if the archive exists and if it does, get the pathname to it.
    #
    my $directory;
    if (GetArchiveDirectory($archive_idx, \$directory) < 0) {
294
	print STDERR "ArchiveAdd: ".
295 296 297 298
	    "Archive '$archive_idx' does not exist in the DB!\n";
	return -1;
    }
    if (! -d $directory || ! -w $directory) {
299
	print STDERR "ArchiveAdd: $directory cannot be written!\n";
300 301
	return -1;
    }
302
    my $repodir   = "$directory/repo";
303 304
    my $checkout  = "$directory/checkouts/$view";
    my $checkin   = "$directory/checkins/$view";
305 306
    
    #
Leigh B. Stoller's avatar
Leigh B. Stoller committed
307 308 309 310
    # 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). 
311
    #
312 313 314 315 316 317 318
    if (! -e "$checkin/$rootdir") {
	mysystem("$MKDIR $checkin/$rootdir") == 0 or return -1;
    }
    
    if (-f "/${rootdir}/${pathname}" || !$exact) {
	mysystem("$TAR cf - -C /$rootdir $pathname | ".
		 "$TAR xf - -C $checkin/$rootdir");
Leigh B. Stoller's avatar
Leigh B. Stoller committed
319 320
    }
    else {
321 322
	mysystem("cd /$rootdir; ".
		 "$RSYNC -R -ax --delete ${pathname} $checkin/$rootdir");
323 324
    }
    if ($?) {
325
	print STDERR "ArchiveAdd: Could not copy in $realpath\n";
326 327 328 329 330 331
	return -1;
    }
    return 0;
}

#
332 333 334 335 336
# 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.
337
#
Leigh B. Stoller's avatar
Leigh B. Stoller committed
338
sub ArchiveSavePoint($;$$$)
339
{
Leigh B. Stoller's avatar
Leigh B. Stoller committed
340
    my ($archive_idx, $savetag, $view, $altdir) = @_;
341 342 343 344 345 346 347 348
    my $cwd;

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

    return -1
	if (TBScriptLock("archive_${archive_idx}", 0, 120) !=
	    TBSCRIPTLOCK_OKAY());
349 350 351 352 353 354

    #
    # See if the archive exists and if it does, get the pathname to it.
    #
    my $directory;
    if (GetArchiveDirectory($archive_idx, \$directory) < 0) {
355
	print STDERR "ArchiveSavePoint: ".
356
	    "Archive '$archive_idx' does not exist in the DB!\n";
357
	goto bad;
358 359
    }
    if (! -d $directory || ! -w $directory) {
360
	print STDERR "ArchiveSavePoint: $directory cannot be written!\n";
361
	goto bad;
362
    }
363
    my $repodir   = "$directory/repo";
Leigh B. Stoller's avatar
Leigh B. Stoller committed
364
    my $checkin   = (defined($altdir) ? $altdir : "$directory/checkins/$view");
365 366 367 368 369 370

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

377
    # Get the current tag for the archive.
378 379
    my ($archive_tag);
    if (GetArchiveCurrentTags($archive_idx, $view, \$archive_tag) < 0) {
380 381 382 383 384 385 386 387 388 389 390 391 392 393
	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";
    }

394
    # Tags must start with a letter.
395 396 397 398
    if ($savetag =~ /^\d+/) {
	$savetag = "T" . $savetag;
    }
    
399
    #
400
    # Use svn import command. This is nice cause it handles all the
401 402 403
    # subdirs and stuff in one shot, instead of trying to deal with
    # each file and directory individually.
    #
404 405 406 407
    if (! chdir("$checkin")) {
	print STDERR "ArchiveSavePoint: Cannot chdir to $checkin!\n";
	goto bad;
    }
408
    mysystem("$IMPORTER -no_user_input file://$repodir ".
409 410
	     "          $view/savepoint . " .
	     ($debug < 2 ? "> /dev/null" : ""))
411 412 413 414 415
	== 0 or goto bad;

    #
    # Create the tag for this savepoint. 
    # 
416
    mysystem("$SVN copy $svnopt -m 'ArchiveCreate Branch' ".
417 418 419 420
	     "          file://$repodir/$view/savepoint ".
	     "          file://$repodir/$view/tags/${savetag}")
	== 0 or goto bad;
    
421 422 423 424

    #
    # And record the new tag. 
    # 
425
    DBQueryWarn("insert into archive_tags set idx=NULL, ".
426
		"  tag='$savetag', view='$view', ".
427
		"  archive_idx='$archive_idx', ".
428
		"  tagtype='$TAGTYPE_SAVEPOINT', ".
429
		"  date_created=UNIX_TIMESTAMP(now())") or goto bad;
430

431
  okay:
432 433 434
    TBScriptUnlock();
    chdir($cwd)
	if (defined($cwd));
435 436 437
    return 0;

  bad:
438 439 440
    TBScriptUnlock();
    chdir($cwd)
	if (defined($cwd));
441 442 443 444 445 446 447
    return -1;
}

#
# Commit the current contents of the temporary store to the archive.
# Returns -1 if any error. Otherwise return 0.
#
448
sub ArchiveCommit($;$$$$)
449
{
450
    my ($archive_idx, $newtag, $mfile, $view, $altdir) = @_;
451
    my $noactivity = 0;
452 453 454 455 456 457 458 459
    my $cwd;

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

    return -1
	if (TBScriptLock("archive_${archive_idx}", 0, 120) !=
	    TBSCRIPTLOCK_OKAY());
460 461 462 463 464 465 466 467

    #
    # 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";
468
	goto bad;
469 470 471
    }
    if (! -d $directory || ! -w $directory) {
	print STDERR "ArchiveCommit: $directory cannot be written!\n";
472
	goto bad;
473
    }
474
    my $repodir   = "$directory/repo";
475 476
    my $checkout  = "$directory/checkouts/$view";
    my $checkin   = (defined($altdir) ? $altdir : "$directory/checkins/$view");
477 478 479 480 481 482 483 484

    # 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
485
	print STDERR "ArchiveCommit: Bad data in $cwd!\n";
486
	goto bad;
487 488
    }

Leigh B. Stoller's avatar
Leigh B. Stoller committed
489 490
    if (! chdir("$directory")) {
	print STDERR "ArchiveCommit: Cannot chdir to $directory!\n";
491
	goto bad;
492 493 494
    }

    # Get the current tags for the archive.
495
    my ($archive_tag, $previous_tag);
496
    if (GetArchiveCurrentTags($archive_idx, $view, \$archive_tag,
497
			      \$previous_tag) < 0) {
498 499 500 501 502 503
	print STDERR "ArchiveCommit: ".
	    "Archive '$archive_idx' does not have a current tag!\n";
	goto bad;
    }

    #
504 505
    # Form new tag.
    # 
506 507 508
    my ($seconds, $microseconds) = gettimeofday();
    my $import_tag  = POSIX::strftime("T20%y%m%d-%H%M%S-", localtime());
    $import_tag    .= $microseconds;
509 510

    if (!defined($newtag)) {
511
	$newtag = $import_tag . "_commit";
512 513
    }

514
    # Tags cannot must start with a letter.
515 516 517
    if ($newtag =~ /^\d+/) {
	$newtag = "T" . $newtag;
    }
518

519 520 521 522 523 524 525
    #
    # 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 ".
526
		    "where archive_idx='$archive_idx' and view='$view' ".
527 528 529 530 531 532 533 534 535
		    "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;
    }
536 537 538 539 540 541 542 543 544 545 546 547 548

    #
    # 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";
    }
549
    
550
    #
551 552 553
    # Okay, do the commit to the trunk for this view.
    # 
    if (! $noactivity) {
Leigh B. Stoller's avatar
Leigh B. Stoller committed
554 555 556 557 558 559 560 561 562
	#
	# Create a temporary spot to work in.
	# 
	if (! mkdir("merge.$$", 0777)) {
	    print STDERR "ArchiveCommit: Could not mkdir merge.$$: $!\n";
	    goto bad;
	}
	chdir("merge.$$");
	
563
	#
564
	# Check out the current trunk.
565
	#
566 567 568
	mysystem("$SVN checkout $svnopt file://$repodir/$view/trunk")
	    == 0 or goto bad;

569
	#
570 571 572 573 574 575 576 577 578 579
	# 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;
580

581
	mysystem("$SVN commit $svnopt $message_arg trunk")
582
	    == 0 or goto bad;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
583 584 585 586 587 588 589

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

592
    # Create a tag in the tags directory for the commit.
593
    mysystem("$SVN copy $svnopt $message_arg ".
594 595 596 597
	     "          file://$repodir/$view/trunk ".
	     "          file://$repodir/$view/tags/${newtag}")
	== 0 or goto bad;
    
Leigh B. Stoller's avatar
Leigh B. Stoller committed
598 599 600
    # 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.
601
    mysystem("$SVN copy $svnopt $message_arg ".
Leigh B. Stoller's avatar
Leigh B. Stoller committed
602 603 604 605
	     "          file://$repodir/$view/trunk ".
	     "          file://$repodir/$view/history/${newtag}")
	== 0 or goto bad;
    
606
    # Create a branch tag in the tags directory to base differences against.
607
    mysystem("$SVN copy $svnopt -m 'ArchiveCommit Branch' ".
608 609 610
	     "          file://$repodir/$view/trunk ".
	     "          file://$repodir/$view/tags/${newtag}-branch")
	== 0 or goto bad;
611 612 613 614

    # For putting message into DB.
    my $dclause = (defined($mfile) ? 
		   ", description=" . DBQuoteSpecial(`cat $mfile`) : "");
615
    
616
    DBQueryWarn("insert into archive_tags set idx=NULL, ".
617
		"  tag='$newtag', view='$view', ".
618
		"  archive_idx='$archive_idx', ".
619 620
		"  tagtype='$TAGTYPE_COMMIT', ".
		"  date_created=UNIX_TIMESTAMP(now()) $dclause")
621
	or goto bad;
622

623
    DBQueryWarn("update archive_views set ".
624
		"  current_tag='$newtag', ".
625
		"  previous_tag='$archive_tag' ".
626 627
		"where archive_idx='$archive_idx' and view='$view'")
	or goto bad;
628

629 630 631
    # And now into the checkout dir to checkout a current copy.
    if (! chdir("$checkout")) {
	print STDERR "ArchiveCommit: Cannot chdir to $checkout!\n";
632
	goto bad;
633
    }
634
    mysystem("$SVN $svnopt update trunk");
635
    if ($?) {
636
	print STDERR "ArchiveCommit: Could not update head revision!\n";
637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656
	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.
#
657
sub ArchiveFork($$;$$$)
658
{
659 660
    my ($archive_idx, $newview, $branchtag, $newtag, $view) = @_;
    my $sourcepoint;
661 662 663 664 665 666 667 668 669 670 671 672 673 674
    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) {
675
	print STDERR "ArchiveFork: ".
676 677 678 679
	    "Archive '$archive_idx' does not exist in the DB!\n";
	goto bad;
    }
    if (! -d $directory || ! -w $directory) {
680
	print STDERR "ArchiveFork: $directory cannot be written!\n";
681
	goto bad;
682
    }
683
    my $repodir     = "$directory/repo";
684 685 686 687 688 689 690 691 692 693 694 695 696
    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
697
	print STDERR "ArchiveFork: Bad data in $cwd!\n";
698 699 700 701
	goto bad;
    }

    # Get the current tags for the archive.
702
    my ($archive_tag, $previous_tag);
703
    if (GetArchiveCurrentTags($archive_idx, $view, \$archive_tag,
704
			      \$previous_tag) < 0) {
705
	print STDERR "ArchiveFork: ".
706 707 708 709
	    "Archive '$archive_idx' does not have a current tag!\n";
	goto bad;
    }

710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725
    #
    # 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;
    }

726 727 728 729 730 731 732 733 734
    # Create new view directories and checkout.
    if (! mkdir("$newcheckin", 0777)) {
	print STDERR "ArchiveCreate: Could not mkdir $newcheckin: $!\n";
	goto bad;
    }
    if (! chmod(0777, "$newcheckin")) {
	print STDERR "ArchiveCreate: Could not chmod $newcheckin: $!\n";
	goto bad;
    }
735 736

    # Create newview directory in the repo.
737
    mysystem("$SVN mkdir $svnopt -m 'ArchiveFork' ".
738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754
	     "          file://$repodir/$newview")
	== 0 or goto bad;

    # Split at the trunk if no branchpoint provided.
    if (defined($branchtag)) {
	$sourcepoint = "tags/$branchtag";
    }
    else {
	$sourcepoint = "trunk"
    }

    # Copy the trunk of the old view.
    mysystem("$SVN copy $svnopt -m 'ArchiveFork' ".
	     "          file://$repodir/$view/$sourcepoint ".
	     "          file://$repodir/$newview/trunk")
	== 0 or goto bad;

755 756 757 758 759 760 761
    # 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.
762
    mysystem("$SVN mkdir $svnopt -m 'ArchiveFork' ".
763
	     "          file://$repodir/$newview/history ".
764 765 766
	     "          file://$repodir/$newview/tags")
	== 0 or goto bad;

767 768 769 770 771 772
    # 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;
    
773
    # Now check it out. This creates the checkouts/$newview directory.
774
    mysystem("cd $checkouts; ".
775
	     "$SVN checkout $svnopt file://$repodir/$newview")
776 777
	== 0 or goto bad;

778 779 780 781 782
    # Now enter the newview (okay, branch) of this archive.
    DBQueryWarn("insert into archive_views set ".
		"  current_tag='$newtag', archive_idx='$archive_idx', ".
		"  view='$newview', ".
		"  date_created=UNIX_TIMESTAMP(now())") or goto bad;
783
    
784 785 786
    # 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', ".
787
		"  tagtype='$TAGTYPE_INTERNAL', ".
788
		"  view='$newview', ".
789
		"  date_created=UNIX_TIMESTAMP(now())") or goto bad;
790

791
  okay:
792 793 794
    TBScriptUnlock();
    chdir($cwd)
	if (defined($cwd));
795
    return 0;
796 797

  bad:
798 799 800
    TBScriptUnlock();
    chdir($cwd)
	if (defined($cwd));
801
    return -1;
802 803
}

804 805 806
#
# Checkout a copy of the archive, optionally at a particular view/branch.
#
807
sub ArchiveCheckout($$;$$$)
808
{
809
    my ($archive_idx, $target, $view, $tag, $subdir) = @_;
810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867
    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"
    }
868 869 870
    # Allowed to check out a particular subdir (but not a file).
    $sourcepoint = $sourcepoint . "/$subdir"
	if (defined($subdir));
871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888

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

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

889 890 891 892 893 894 895 896 897 898 899 900 901 902 903
#
# Archive the Archive, moving it into the expinfo directory.
# I intend this to be run only when an experiment is terminated.
# No need to have two copies.
#
sub ArchiveArchive($$)
{
    my ($archive_idx, $dirpath) = @_;
    my $target = "$dirpath/Archive";

    #
    # See if the archive exists and if it does, get the pathname to it.
    #
    my $directory;
    if (GetArchiveDirectory($archive_idx, \$directory) < 0) {
904
	print STDERR "ArchiveArchive: ".
905 906 907
	    "Archive '$archive_idx' does not exist in the DB!\n";
	return -1;
    }
908 909 910 911 912 913 914 915 916 917 918 919 920 921 922

    #
    # Need additional check to make sure that it has not already been
    # archived.
    #
    my ($archived, $date_archived);
    
    if (IsArchiveArchived($archive_idx, \$archived, \$date_archived) < 0) {
	return -1;
    }
    if ($archived) {
	print STDERR "ArchiveArchive: ".
	    "Archive '$archive_idx' already archived on $date_archived!\n";
	return 0;
    }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
923 924 925 926 927 928 929 930 931 932 933

    # Is it shared? If so, certainly do not archive it!
    my $shared;
    if (IsArchiveShared($archive_idx, \$shared) < 0) {
	return -1;
    }
    if ($shared) {
	print STDERR "ArchiveArchive: ".
	    "Archive '$archive_idx' is shared; not archiving!\n";
	return 0;
    }
934
    
935
    if (! -d $directory || ! -w $directory) {
936
	print STDERR "ArchiveArchive: $directory cannot be written!\n";
937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954
	return -1;
    }

    if (! -e $target) {
	if (! mkdir("$target", 0777)) {
	    print STDERR "ArchiveArchive: Could not mkdir $target: $!\n";
	    return -1;
	}
	if (! chmod(0777, "$target")) {
	    print STDERR "ArchiveArchive: ".
		"Could not chmod directory $target: $!\n";
	    return -1;
	}
    }    

    #
    # Tar up the whole thing and move it across.
    #
955
    mysystem("$TAR cf - -C $directory repo | tar xf - -C $target");
956 957 958 959
    if ($?) {
	print STDERR "ArchiveArchive: Could not copy in $directory\n";
	return -1;
    }
960 961 962 963

    #
    # Update its location in the DB, and remove the old directory.
    # 
964 965 966 967
    DBQueryWarn("update archives set ".
		"   directory='$target', ".
		"   archived=1, ".
		"   date_archived=UNIX_TIMESTAMP(now()) ".
968 969 970 971 972 973 974 975 976
		"where idx='$archive_idx'")
	or return -1;
    
    mysystem("/bin/rm -rf $directory");
    if ($?) {
	print STDERR "ArchiveArchive: ".
	    "Could not remove contents of $directory!\n";
	return -1;
    }
977 978 979 980 981 982 983
    return 0;
}

#
# Destroy an archive. The DB state is retained unless optional flag says
# to clean it.
#
984
sub ArchiveDestroy($$;$)
985
{
986 987 988 989
    my ($archive_idx, $clean, $view) = @_;

    $view = $defaultview
	if (!defined($view));
990 991 992 993 994 995 996 997 998 999

    #
    # See if the archive exists and if it does, get the pathname to it.
    #
    my $directory;
    if (GetArchiveDirectory($archive_idx, \$directory) < 0) {
	print STDERR "ArchiveDestroy: ".
	    "Archive '$archive_idx' does not exist in the DB!\n";
	return -1;
    }
1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015

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

1020 1021 1022
    # Is it shared? If so, certainly do not delete it!
    my $shared;
    if (IsArchiveShared($archive_idx, \$shared) < 0) {
1023 1024
	return -1;
    }
1025 1026 1027 1028 1029 1030 1031 1032 1033
    if (! $shared) {
	mysystem("/bin/rm -rf $directory");
	if ($?) {
	    print STDERR "ArchiveDestroy: ".
		"Could not remove contents of $directory!\n";
	    return -1;
	}
    }
    
1034
    if ($clean) {
1035
	(DBQueryWarn("delete from archive_tags ".
1036
		     "where archive_idx='$archive_idx' and view='$view'") &&
1037
	 DBQueryWarn("delete from archive_views ".
1038 1039 1040 1041 1042 1043 1044
		     "where archive_idx='$archive_idx' and view='$view'"))
	    || return -1;
	
	if (! $shared) {
	    DBQueryWarn("delete from archives ".
			"where idx='$archive_idx'") || return -1;
	}
1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057
    }
    return 0;
}

#
# Get the directory for an archive, given its index. Returns -1 on error,
# zero otherwise. 
#
sub GetArchiveDirectory($$)
{
    my ($idx, $rvalp) = @_;
    
    my $query_result =
Leigh B. Stoller's avatar
Leigh B. Stoller committed
1058
	DBQueryWarn("select directory from archives where idx='$idx'");
1059 1060 1061 1062 1063 1064 1065 1066 1067 1068

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

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

1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092
#
# See if the archive has already been archived away, and when.
#
sub IsArchiveArchived($$$)
{
    my ($idx, $parch, $pdate) = @_;
    
    my $query_result =
	DBQueryWarn("select archived,FROM_UNIXTIME(date_archived) ".
		    "  from archives where idx='$idx'");

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

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

1093 1094