libArchive.pm.in 56.1 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 58 59 60 61 62
my $SHAREROOT   = SHAREROOT();
my $SCRATCHROOT = SCRATCHROOT();
my %ROOTS       = (PROJROOT()  => "proj",
		   USERROOT()  => "users",
		   $SHAREROOT  => "share",
		   GROUPROOT() => "groups");
if ($SCRATCHROOT) {
    $ROOTS{$SCRATCHROOT} = "scratch";
}
63

64 65 66 67 68
my $TAGTYPE_USER      = "user";
my $TAGTYPE_COMMIT    = "commit";
my $TAGTYPE_SAVEPOINT = "savepoint";
my $TAGTYPE_INTERNAL  = "internal";

69 70 71 72 73
#
# Set umask so that other people in the project can mess with the archive.
#
umask(0002);

74 75 76 77 78 79 80 81 82 83 84
# On or off
sub doarchiving($)
{
    my ($pid) = @_;
    
    return 1
	if ($USEARCHIVE && exists($ALLOWEDPID{$pid}));
    
    return 0;
}

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

Leigh B. Stoller's avatar
Leigh B. Stoller committed
90 91
    TBDebugTimeStampsOn();    

92 93 94 95
    # Need a big TMPDIR for svn stuff.
    my $tmpdir = $ENV{'TMPDIR'};
    $ENV{'TMPDIR'} = "/usr/testbed/tmp";

96 97
    print STDERR "Running '$command'\n"
	if ($debug);
Leigh B. Stoller's avatar
Leigh B. Stoller committed
98 99

    TBDebugTimeStamp($command);
Leigh B. Stoller's avatar
Leigh B. Stoller committed
100
    my $retval = system($command);
Leigh B. Stoller's avatar
Leigh B. Stoller committed
101
    TBDebugTimeStamp("Done");
102 103
    $ENV{'TMPDIR'} = $tmpdir
	if (defined($tmpdir));
Leigh B. Stoller's avatar
Leigh B. Stoller committed
104 105

    return $retval;
106 107
}

108 109 110 111 112 113
# Another little helper for scripts that include this library.
sub setdebug($)
{
    my ($toggle) = @_;

    if ($toggle) {
114
	$debug  = $toggle;
115 116 117 118 119 120 121 122
	$svnopt = "";
    }
    else {
	$debug  = 0;
	$svnopt = "-q";
    }
}

123 124 125 126
#
# Create a new archive. Returns -1 if any error. Otherwise return
# the new record index.
# 
127
sub ArchiveCreate(;$$$)
128
{
129
    my ($tag, $view, $unix_gid) = @_;
130
    
131 132
    my $idx;
    my $dir;
133 134 135

    $tag = $inittag
	if (!defined($tag));
136 137
    $view = $defaultview
	if (!defined($view));
138

139
    # Tags cannot must start with a letter.
140 141 142
    if ($tag =~ /^\d+/) {
	$tag = "T" . $tag;
    }
143 144 145 146 147

    #
    # Need to create the directory for it, once we have the index.
    # 
    my $query_result =
Leigh B. Stoller's avatar
Leigh B. Stoller committed
148
	DBQueryWarn("insert into archives set ".
149
		    "  idx=NULL, ".
150 151 152 153 154 155 156 157 158 159 160 161 162 163
		    "  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;
164 165 166
    if (defined($unix_gid)) {
	mysystem("$CHGRP $unix_gid $dir") == 0 or goto bad;
    }
167

Leigh B. Stoller's avatar
Leigh B. Stoller committed
168
    DBQueryWarn("update archives set directory='$dir' where idx='$idx'")
169 170 171
	or goto bad;

    #
172
    # Make subdirs. One to hold the control tree, and the other
173 174
    # to hold currently checked out versions of the tree. Lastly, we
    # need a place to copyin files before they are added to the repo.
175
    #
176
    my $repodir   = "$dir/repo";
177 178
    my $checkouts = "$dir/checkouts";
    my $checkins  = "$dir/checkins";
179

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

    # Create a branch tag in the tags directory to base differences against.
225
    mysystem("$SVN copy $svnopt -m 'ArchiveCreate Branch' ".
226 227
	     "          file://$repodir/$view/trunk ".
	     "          file://$repodir/$view/tags/${tag}-branch")
228
	== 0 or goto bad;
229 230 231 232 233 234 235 236

    # 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;
237
    
238 239
    # Now check it out. This creates the $checkouts/$view directory.
    mysystem("cd $checkouts; ".
240
	     "$SVN checkout $svnopt file://$repodir/$view")
241 242
	== 0 or goto bad;

243 244 245 246 247
    # 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;
    
248
    # Now enter an initial tag for the tree. Nothing actually gets tagged.
249 250
    DBQueryWarn("insert into archive_tags set idx=NULL, ".
		"  tag='$tag', archive_idx='$idx', view='$view', ".
251
		"  tagtype='$TAGTYPE_INTERNAL', ".
252 253 254 255 256 257 258
		"  date_created=UNIX_TIMESTAMP(now())") or goto bad;
    
    return $idx;

  bad:
#    mysystem("$RM -rf $dir")
#        if (defined($dir));
259 260 261
    DBQueryFatal("delete from archive_views ".
		 "where view='$view' and archive_idx='$idx'")
	if (defined($idx));
Leigh B. Stoller's avatar
Leigh B. Stoller committed
262
    DBQueryFatal("delete from archives where idx='$idx'")
263 264 265 266 267
	if (defined($idx));
    return -1;
}

#
268
# Helper function for below; Checks that a path is safe and legal.
269
#
270
sub ValidatePath($)
271
{
272 273 274
    my ($ppath)  = @_;
    # We get a pointer so we can return the new path.
    my $pathname = $$ppath;
275
    my $rootdir;
276

277 278 279 280 281
    # Taint check path before handing off to shell below.
    if ($pathname =~ /^([-\w\/\.\+\@,~]+)$/) {
	$pathname = $1;
    }
    else {
282 283
	print STDERR "*** ValidatePath: illegal characters in '$pathname'\n";
	return 1;
284 285
    }

286
    if (! -e $pathname || ! -r $pathname) {
287 288
	print STDERR "*** ValidatePath: $pathname cannot be read!\n";
	return 1;
289 290 291
    }

    #
292 293
    # Use realpath to check that the path does not contain links to
    # files outside the directory space the user is allowed to access.
294
    # We must taint check the result to keep everyone happy.
295
    #
Leigh B. Stoller's avatar
Leigh B. Stoller committed
296
    my $realpath = `$REALPATH $pathname`;
297
    if ($realpath =~ /^([-\w\/\.\+\@,~]+)$/) {
298 299 300
	$realpath = $1;
    }
    else {
301
	print STDERR "*** ValidatePath: ".
302
	    "Bad data returned by realpath: $realpath\n";
303
	return -1;
304
    }
305

306
    #
307 308
    # Strip leading /dir from the pathname. We want a relative path to
    # the rootdir so we can copy it in.
309
    #
310
    if ($realpath =~ /^[\/]+(\w+)\/(.+)$/) {
311
	$rootdir  = "/$1";
312
	$pathname = $2;
313 314
    }
    else {
315 316
	print STDERR "*** ValidatePath: ".
	    "Illegal characters in pathname: $realpath\n";
317 318 319 320 321 322 323
	return -1;
    }

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

329 330 331 332 333 334 335 336 337 338
    $$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. 
#
339
sub ArchiveAdd($$;$$$)
340
{
341
    my ($archive_idx, $pathname, $view, $exact, $special) = @_;
342 343 344 345 346 347 348

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

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

349 350 351
    $special = 0
	if (!defined($special));

352 353 354 355 356 357 358 359 360
    # 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.
    #
361 362 363 364 365
    my ($rootdir, $sourcedir, $sourcefile);
    my $rsyncopt = "";
    
    if ($special) {
	#
366 367 368 369 370 371
	# 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.
372 373
	#
	if (! -d $pathname) {
374
	    print STDERR "ArchiveAdd: Must be a directory: $pathname\n";
375 376 377 378 379 380 381 382 383 384 385 386 387
	    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";
388 389 390 391 392 393
    }
    else {
	print STDERR "ArchiveAdd: Illegal characters in pathname $pathname\n";
	return -1;
    }

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

#
438 439 440 441 442
# 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.
443
#
Leigh B. Stoller's avatar
Leigh B. Stoller committed
444
sub ArchiveSavePoint($;$$$)
445
{
Leigh B. Stoller's avatar
Leigh B. Stoller committed
446
    my ($archive_idx, $savetag, $view, $altdir) = @_;
447 448 449 450 451 452 453 454
    my $cwd;

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

    return -1
	if (TBScriptLock("archive_${archive_idx}", 0, 120) !=
	    TBSCRIPTLOCK_OKAY());
455 456 457 458 459 460

    #
    # See if the archive exists and if it does, get the pathname to it.
    #
    my $directory;
    if (GetArchiveDirectory($archive_idx, \$directory) < 0) {
461
	print STDERR "ArchiveSavePoint: ".
462
	    "Archive '$archive_idx' does not exist in the DB!\n";
463
	goto bad;
464 465
    }
    if (! -d $directory || ! -w $directory) {
466
	print STDERR "ArchiveSavePoint: $directory cannot be written!\n";
467
	goto bad;
468
    }
469
    my $repodir   = "$directory/repo";
Leigh B. Stoller's avatar
Leigh B. Stoller committed
470
    my $checkin   = (defined($altdir) ? $altdir : "$directory/checkins/$view");
471 472 473 474 475 476

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

483
    # Get the current tag for the archive.
484 485
    my ($archive_tag);
    if (GetArchiveCurrentTags($archive_idx, $view, \$archive_tag) < 0) {
486 487 488 489 490 491 492 493 494 495 496 497 498 499
	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";
    }

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

    #
    # Create the tag for this savepoint. 
    # 
523
    mysystem("$SVN copy $svnopt -m 'ArchiveCreate Branch' ".
524 525 526 527
	     "          file://$repodir/$view/savepoint ".
	     "          file://$repodir/$view/tags/${savetag}")
	== 0 or goto bad;
    
528 529 530 531

    #
    # And record the new tag. 
    # 
532
    DBQueryWarn("insert into archive_tags set idx=NULL, ".
533
		"  tag='$savetag', view='$view', ".
534
		"  archive_idx='$archive_idx', ".
535
		"  tagtype='$TAGTYPE_SAVEPOINT', ".
536
		"  date_created=UNIX_TIMESTAMP(now())") or goto bad;
537

538
  okay:
539 540 541
    TBScriptUnlock();
    chdir($cwd)
	if (defined($cwd));
542 543 544
    return 0;

  bad:
545 546 547
    TBScriptUnlock();
    chdir($cwd)
	if (defined($cwd));
548 549 550 551 552 553 554
    return -1;
}

#
# Commit the current contents of the temporary store to the archive.
# Returns -1 if any error. Otherwise return 0.
#
555
sub ArchiveCommit($;$$$$)
556
{
557
    my ($archive_idx, $newtag, $mfile, $view, $altdir) = @_;
558
    my $noactivity = 0;
559 560 561 562 563 564 565 566
    my $cwd;

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

    return -1
	if (TBScriptLock("archive_${archive_idx}", 0, 120) !=
	    TBSCRIPTLOCK_OKAY());
567 568 569 570 571 572 573 574

    #
    # 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";
575
	goto bad;
576 577 578
    }
    if (! -d $directory || ! -w $directory) {
	print STDERR "ArchiveCommit: $directory cannot be written!\n";
579
	goto bad;
580
    }
581
    my $repodir   = "$directory/repo";
582 583
    my $checkout  = "$directory/checkouts/$view";
    my $checkin   = (defined($altdir) ? $altdir : "$directory/checkins/$view");
584 585 586 587 588 589 590 591

    # 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
592
	print STDERR "ArchiveCommit: Bad data in $cwd!\n";
593
	goto bad;
594 595
    }

Leigh B. Stoller's avatar
Leigh B. Stoller committed
596 597
    if (! chdir("$directory")) {
	print STDERR "ArchiveCommit: Cannot chdir to $directory!\n";
598
	goto bad;
599 600 601
    }

    # Get the current tags for the archive.
602
    my ($archive_tag, $previous_tag);
603
    if (GetArchiveCurrentTags($archive_idx, $view, \$archive_tag,
604
			      \$previous_tag) < 0) {
605 606 607 608 609 610
	print STDERR "ArchiveCommit: ".
	    "Archive '$archive_idx' does not have a current tag!\n";
	goto bad;
    }

    #
611 612
    # Form new tag.
    # 
613 614 615
    my ($seconds, $microseconds) = gettimeofday();
    my $import_tag  = POSIX::strftime("T20%y%m%d-%H%M%S-", localtime());
    $import_tag    .= $microseconds;
616 617

    if (!defined($newtag)) {
618
	$newtag = $import_tag . "_commit";
619 620
    }

621
    # Tags cannot must start with a letter.
622 623 624
    if ($newtag =~ /^\d+/) {
	$newtag = "T" . $newtag;
    }
625

626 627 628 629 630 631 632
    #
    # 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 ".
633
		    "where archive_idx='$archive_idx' and view='$view' ".
634 635 636 637 638 639 640 641 642
		    "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;
    }
643 644 645 646 647 648 649 650 651 652 653 654 655

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

676
	#
677 678 679 680 681 682 683 684 685 686
	# 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;
687

688
	mysystem("$SVN commit $svnopt $message_arg trunk")
689
	    == 0 or goto bad;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
690 691 692 693 694 695 696

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

699
    # Create a tag in the tags directory for the commit.
700
    mysystem("$SVN copy $svnopt $message_arg ".
701 702 703 704
	     "          file://$repodir/$view/trunk ".
	     "          file://$repodir/$view/tags/${newtag}")
	== 0 or goto bad;
    
Leigh B. Stoller's avatar
Leigh B. Stoller committed
705 706 707
    # 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.
708
    mysystem("$SVN copy $svnopt $message_arg ".
Leigh B. Stoller's avatar
Leigh B. Stoller committed
709 710 711 712
	     "          file://$repodir/$view/trunk ".
	     "          file://$repodir/$view/history/${newtag}")
	== 0 or goto bad;
    
713
    # Create a branch tag in the tags directory to base differences against.
714
    mysystem("$SVN copy $svnopt -m 'ArchiveCommit Branch' ".
715 716 717
	     "          file://$repodir/$view/trunk ".
	     "          file://$repodir/$view/tags/${newtag}-branch")
	== 0 or goto bad;
718 719 720 721

    # For putting message into DB.
    my $dclause = (defined($mfile) ? 
		   ", description=" . DBQuoteSpecial(`cat $mfile`) : "");
722
    
723
    DBQueryWarn("insert into archive_tags set idx=NULL, ".
724
		"  tag='$newtag', view='$view', ".
725
		"  archive_idx='$archive_idx', ".
726 727
		"  tagtype='$TAGTYPE_COMMIT', ".
		"  date_created=UNIX_TIMESTAMP(now()) $dclause")
728
	or goto bad;
729

730
    DBQueryWarn("update archive_views set ".
731
		"  current_tag='$newtag', ".
732
		"  previous_tag='$archive_tag' ".
733 734
		"where archive_idx='$archive_idx' and view='$view'")
	or goto bad;
735

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

    # Get the current tags for the archive.
809
    my ($archive_tag, $previous_tag);
810
    if (GetArchiveCurrentTags($archive_idx, $view, \$archive_tag,
811
			      \$previous_tag) < 0) {
812
	print STDERR "ArchiveFork: ".
813 814 815 816
	    "Archive '$archive_idx' does not have a current tag!\n";
	goto bad;
    }

817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832
    #
    # 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;
    }

833 834
    # Create new view directories and checkout.
    if (! mkdir("$newcheckin", 0777)) {
835
	print STDERR "ArchiveFork: Could not mkdir $newcheckin: $!\n";
836 837 838
	goto bad;
    }
    if (! chmod(0777, "$newcheckin")) {
839
	print STDERR "ArchiveFork: Could not chmod $newcheckin: $!\n";
840 841
	goto bad;
    }
842 843

    # Create newview directory in the repo.
844
    mysystem("$SVN mkdir $svnopt -m 'ArchiveFork' ".
845 846 847
	     "          file://$repodir/$newview")
	== 0 or goto bad;

848 849 850 851 852 853 854 855 856 857 858 859
    #
    # 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;
860
    }
861
    $sourcepoint = "tags/$branchtag";
862 863 864 865 866 867 868

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

869 870 871 872 873 874 875
    # 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.
876
    mysystem("$SVN mkdir $svnopt -m 'ArchiveFork' ".
877
	     "          file://$repodir/$newview/history ".
878 879 880
	     "          file://$repodir/$newview/tags")
	== 0 or goto bad;

881 882 883 884 885
    # 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;
886 887 888 889 890 891 892 893

    # 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;
894
    
895
    # Now check it out. This creates the checkouts/$newview directory.
896
    mysystem("cd $checkouts; ".
897
	     "$SVN checkout $svnopt file://$repodir/$newview")
898 899
	== 0 or goto bad;

900 901 902 903
    # Now enter the newview (okay, branch) of this archive.
    DBQueryWarn("insert into archive_views set ".
		"  current_tag='$newtag', archive_idx='$archive_idx', ".
		"  view='$newview', ".
904
		"  parent_view='$view', branch_tag='$branchtag', ".
905
		"  date_created=UNIX_TIMESTAMP(now())") or goto bad;
906
    
907 908 909
    # 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', ".
910
		"  tagtype='$TAGTYPE_INTERNAL', ".
911
		"  view='$newview', ".
912
		"  date_created=UNIX_TIMESTAMP(now())") or goto bad;
913

914
  okay:
915 916 917
    TBScriptUnlock();
    chdir($cwd)
	if (defined($cwd));
918
    return 0;
919 920

  bad:
921 922 923
    TBScriptUnlock();
    chdir($cwd)
	if (defined($cwd));
924
    return -1;
925 926
}

927 928 929
#
# Checkout a copy of the archive, optionally at a particular view/branch.
#
930
sub ArchiveCheckout($$;$$$)
931
{
932
    my ($archive_idx, $target, $view, $tag, $subdir) = @_;
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 981 982 983 984 985 986 987 988 989 990
    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"
    }
991 992 993
    # Allowed to check out a particular subdir (but not a file).
    $sourcepoint = $sourcepoint . "/$subdir"
	if (defined($subdir));
994

995
    # Now check it out, although we actually use export to avoid .svn files.
996
    mysystem("cd $target; ".