libArchive.pm.in 61.7 KB
Newer Older
1 2 3
#!/usr/bin/perl -wT
#
# EMULAB-COPYRIGHT
4
# Copyright (c) 2005, 2006, 2007 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 34
my %ALLOWEDPID  = ("testbed" => 1, "compadres" => 1, "tbres" => 1,
		   "fightfire" => 1);
35 36 37 38 39 40 41 42
# 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";
43
my $SUCHOWN     = "$TB/sbin/suchown";
44
my $CHGRP       = "/usr/bin/chgrp";
45
my $TAR		= "/usr/bin/tar";
Leigh B. Stoller's avatar
Leigh B. Stoller committed
46
my $RSYNC	= "/usr/local/bin/rsync";
47
my $RM		= "/bin/rm";
Leigh B. Stoller's avatar
Leigh B. Stoller committed
48
my $REALPATH	= "/bin/realpath";
49 50 51
my $SVN         = "/usr/local/bin/svn";
my $SVNADMIN    = "/usr/local/bin/svnadmin";
my $IMPORTER    = "$TB/sbin/svn_load_dirs.pl";
52
my $DU          = "/usr/bin/du";
53
my $inittag     = 'root';
54
my $defaultview = 'head';
55
my $debug       = 0;
56
my $svnopt      = ($debug ? "" : "-q");
57 58 59 60 61 62 63 64 65
my $SHAREROOT   = SHAREROOT();
my $SCRATCHROOT = SCRATCHROOT();
my %ROOTS       = (PROJROOT()  => "proj",
		   USERROOT()  => "users",
		   $SHAREROOT  => "share",
		   GROUPROOT() => "groups");
if ($SCRATCHROOT) {
    $ROOTS{$SCRATCHROOT} = "scratch";
}
66

67 68 69 70 71
my $TAGTYPE_USER      = "user";
my $TAGTYPE_COMMIT    = "commit";
my $TAGTYPE_SAVEPOINT = "savepoint";
my $TAGTYPE_INTERNAL  = "internal";

72 73 74 75 76
#
# Set umask so that other people in the project can mess with the archive.
#
umask(0002);

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

88 89 90 91 92
# Little helper and debug function.
sub mysystem($)
{
    my ($command) = @_;

Leigh B. Stoller's avatar
Leigh B. Stoller committed
93 94
    TBDebugTimeStampsOn();    

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

99 100
    print STDERR "Running '$command'\n"
	if ($debug);
Leigh B. Stoller's avatar
Leigh B. Stoller committed
101 102

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

    return $retval;
109 110
}

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

    if ($toggle) {
117
	$debug  = $toggle;
118 119 120 121 122 123 124 125
	$svnopt = "";
    }
    else {
	$debug  = 0;
	$svnopt = "-q";
    }
}

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

    $tag = $inittag
	if (!defined($tag));
139 140
    $view = $defaultview
	if (!defined($view));
141

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

352 353 354
    $special = 0
	if (!defined($special));

355 356 357 358 359 360 361 362 363
    # 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.
    #
364 365 366 367 368
    my ($rootdir, $sourcedir, $sourcefile);
    my $rsyncopt = "";
    
    if ($special) {
	#
369 370
	# What does this do? 
	# Basically, we copy the last part (directory) to / of the checkin.
371
	# eg: cp /proj/pid/exp/eid... /exp of the checkins.
372 373 374
	# This avoids pid/eid tokens in the archive.
	#
	# Last part of path must be a directory.
375 376
	#
	if (! -d $pathname) {
377
	    print STDERR "ArchiveAdd: Must be a directory: $pathname\n";
378 379
	    return -1;
	}
380 381 382
	$rootdir    = "exp";
	$sourcedir  = $pathname;
	$sourcefile = "./";
383 384 385 386 387 388
    }
    elsif ($pathname =~ /^[\/]+(\w+)\/([-\w\/\.\+\@,~]+)$/) {
	$rootdir    = $1;
	$sourcedir  = $1;
	$sourcefile = $2;
	$rsyncopt   = "-R";
389 390 391 392 393 394
    }
    else {
	print STDERR "ArchiveAdd: Illegal characters in pathname $pathname\n";
	return -1;
    }

395 396 397 398 399
    #
    # See if the archive exists and if it does, get the pathname to it.
    #
    my $directory;
    if (GetArchiveDirectory($archive_idx, \$directory) < 0) {
400
	print STDERR "ArchiveAdd: ".
401 402 403 404
	    "Archive '$archive_idx' does not exist in the DB!\n";
	return -1;
    }
    if (! -d $directory || ! -w $directory) {
405
	print STDERR "ArchiveAdd: $directory cannot be written!\n";
406 407
	return -1;
    }
408
    my $repodir   = "$directory/repo";
409
    my $checkin   = "$directory/checkins/$view";
410 411 412 413 414 415 416 417 418

    #
    # If the target rootdir exists and is not writable by the current
    # user, then run a chown over the whole subdir. This will avoid
    # avoid permission problems later during the rsync/tar ops below.
    #
    if (-e "$checkin/$rootdir" && ! -o "$checkin/$rootdir") {
	mysystem("$SUCHOWN $checkin/$rootdir") == 0 or return -1
    }
419 420
    
    #
Leigh B. Stoller's avatar
Leigh B. Stoller committed
421 422 423 424
    # 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). 
425
    #
426
    if (! -e "$checkin/$rootdir") {
427
	mysystem("$MKDIR $checkin/$rootdir") == 0 or return -1
428 429
    }
    
430 431
    if (-f "/${sourcedir}/${sourcefile}" || !$exact) {
	mysystem("$TAR cf - -C /$sourcedir $sourcefile | ".
432
		 "$TAR xf - -U -C $checkin/$rootdir");
433
	mysystem("$CHMOD 775 $checkin/$rootdir/$sourcefile");
Leigh B. Stoller's avatar
Leigh B. Stoller committed
434 435
    }
    else {
436 437 438
	mysystem("cd /$sourcedir; ".
		 "$RSYNC $rsyncopt -rtgoDlz ".
		 "  --delete ${sourcefile} $checkin/$rootdir");
439 440
    }
    if ($?) {
441
	print STDERR "ArchiveAdd: Could not copy in $pathname\n";
442 443 444 445 446 447
	return -1;
    }
    return 0;
}

#
448 449 450 451 452
# 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.
453
#
Leigh B. Stoller's avatar
Leigh B. Stoller committed
454
sub ArchiveSavePoint($;$$$)
455
{
Leigh B. Stoller's avatar
Leigh B. Stoller committed
456
    my ($archive_idx, $savetag, $view, $altdir) = @_;
457 458 459 460 461 462
    my $cwd;

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

    return -1
463
	if (TBScriptLock("archive_${archive_idx}_${view}", 0, 600) !=
464
	    TBSCRIPTLOCK_OKAY());
465 466 467 468 469 470

    #
    # See if the archive exists and if it does, get the pathname to it.
    #
    my $directory;
    if (GetArchiveDirectory($archive_idx, \$directory) < 0) {
471
	print STDERR "ArchiveSavePoint: ".
472
	    "Archive '$archive_idx' does not exist in the DB!\n";
473
	goto bad;
474 475
    }
    if (! -d $directory || ! -w $directory) {
476
	print STDERR "ArchiveSavePoint: $directory cannot be written!\n";
477
	goto bad;
478
    }
479
    my $repodir   = "$directory/repo";
Leigh B. Stoller's avatar
Leigh B. Stoller committed
480
    my $checkin   = (defined($altdir) ? $altdir : "$directory/checkins/$view");
481 482 483 484 485 486

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

493
    # Get the current tag for the archive.
494 495
    my ($archive_tag);
    if (GetArchiveCurrentTags($archive_idx, $view, \$archive_tag) < 0) {
496 497 498 499 500 501 502 503 504 505 506 507 508 509
	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";
    }

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

    #
    # Create the tag for this savepoint. 
    # 
533
    mysystem("$SVN copy $svnopt -m 'ArchiveCreate Branch' ".
534 535 536 537
	     "          file://$repodir/$view/savepoint ".
	     "          file://$repodir/$view/tags/${savetag}")
	== 0 or goto bad;
    
538 539 540 541

    #
    # And record the new tag. 
    # 
542
    DBQueryWarn("insert into archive_tags set idx=NULL, ".
543
		"  tag='$savetag', view='$view', ".
544
		"  archive_idx='$archive_idx', ".
545
		"  tagtype='$TAGTYPE_SAVEPOINT', ".
546
		"  date_created=UNIX_TIMESTAMP(now())") or goto bad;
547

548
  okay:
549 550 551
    TBScriptUnlock();
    chdir($cwd)
	if (defined($cwd));
552 553 554
    return 0;

  bad:
555 556 557
    TBScriptUnlock();
    chdir($cwd)
	if (defined($cwd));
558 559 560
    return -1;
}

561 562 563 564 565 566 567 568 569 570 571 572 573 574
#
# Add an informational tag to an archive, in the tags directory. This just
# does a copy of the current trunk, and is intended to allow users to add
# their own named tags as they like.
#
sub ArchiveTag($;$$$)
{
    my ($archive_idx, $savetag, $subdir, $view) = @_;
    my $cwd;

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

    return -1
575
	if (TBScriptLock("archive_${archive_idx}_${view}", 0, 600) !=
576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662
	    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 "ArchiveTag: ".
	    "Archive '$archive_idx' does not exist in the DB!\n";
	goto bad;
    }
    if (! -d $directory || ! -w $directory) {
	print STDERR "ArchiveTag: $directory cannot be written!\n";
	goto bad;
    }
    my $repodir   = "$directory/repo";

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

    # Tags must start with a letter.
    if ($savetag =~ /^\d+/) {
	$savetag = "T" . $savetag;
    }

    #
    # Check to see if the subdir needs to be created. I cannot find a
    # better way then the svn list command ...
    #
    if (defined($subdir)) {
	my @tokens = split("/", $subdir);
	my $path   = "";

	while (@tokens) {
	    my $token = shift(@tokens);

	    $path = "$path/$token";

	    mysystem("$SVN list file://$repodir/$view/tags${path} ".
		     "  > /dev/null");
	    if ($?) {
		mysystem("$SVN mkdir $svnopt -m 'ArchiveTag mkdir' ".
			 "          file://$repodir/$view/tags${path}")
		    == 0 or goto bad;
	    }
	}

	# Prepend subdir to tag
	$savetag = "$subdir/$savetag";
    }

    # Check to make sure the complete path does not already exist
    mysystem("$SVN list file://$repodir/$view/tags/${savetag} > /dev/null");
    if (! $?) {
	print STDERR "ArchiveTag: tag already exists!\n";
	goto bad;
    }
    
    #
    # Create the tag ...
    # 
    mysystem("$SVN copy $svnopt -m 'ArchiveTag' ".
	     "          file://$repodir/$view/trunk ".
	     "          file://$repodir/$view/tags/${savetag}")
	== 0 or goto bad;

  okay:
    TBScriptUnlock();
    chdir($cwd)
	if (defined($cwd));
    return 0;

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

663 664 665 666
#
# Commit the current contents of the temporary store to the archive.
# Returns -1 if any error. Otherwise return 0.
#
667
sub ArchiveCommit($;$$$$)
668
{
669
    my ($archive_idx, $newtag, $mfile, $view, $altdir) = @_;
670
    my $noactivity = 0;
671 672 673 674 675 676
    my $cwd;

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

    return -1
677
	if (TBScriptLock("archive_${archive_idx}_${view}", 0, 600) !=
678
	    TBSCRIPTLOCK_OKAY());
679 680 681 682 683 684 685 686

    #
    # 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";
687
	goto bad;
688 689 690
    }
    if (! -d $directory || ! -w $directory) {
	print STDERR "ArchiveCommit: $directory cannot be written!\n";
691
	goto bad;
692
    }
693
    my $repodir   = "$directory/repo";
694 695
    my $checkout  = "$directory/checkouts/$view";
    my $checkin   = (defined($altdir) ? $altdir : "$directory/checkins/$view");
696 697 698 699 700 701 702 703

    # 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
704
	print STDERR "ArchiveCommit: Bad data in $cwd!\n";
705
	goto bad;
706 707
    }

Leigh B. Stoller's avatar
Leigh B. Stoller committed
708 709
    if (! chdir("$directory")) {
	print STDERR "ArchiveCommit: Cannot chdir to $directory!\n";
710
	goto bad;
711 712 713
    }

    # Get the current tags for the archive.
714
    my ($archive_tag, $previous_tag);
715
    if (GetArchiveCurrentTags($archive_idx, $view, \$archive_tag,
716
			      \$previous_tag) < 0) {
717 718 719 720 721 722
	print STDERR "ArchiveCommit: ".
	    "Archive '$archive_idx' does not have a current tag!\n";
	goto bad;
    }

    #
723 724
    # Form new tag.
    # 
725 726 727
    my ($seconds, $microseconds) = gettimeofday();
    my $import_tag  = POSIX::strftime("T20%y%m%d-%H%M%S-", localtime());
    $import_tag    .= $microseconds;
728 729

    if (!defined($newtag)) {
730
	$newtag = $import_tag . "_commit";
731 732
    }

733
    # Tags cannot must start with a letter.
734 735 736
    if ($newtag =~ /^\d+/) {
	$newtag = "T" . $newtag;
    }
737

738 739 740 741 742 743 744
    #
    # 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 ".
745
		    "where archive_idx='$archive_idx' and view='$view' ".
746 747 748 749 750 751 752 753 754
		    "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;
    }
755 756 757 758 759 760 761 762 763 764 765 766 767

    #
    # 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";
    }
768
    
769
    #
770 771 772
    # Okay, do the commit to the trunk for this view.
    # 
    if (! $noactivity) {
Leigh B. Stoller's avatar
Leigh B. Stoller committed
773 774 775 776 777 778 779 780 781
	#
	# Create a temporary spot to work in.
	# 
	if (! mkdir("merge.$$", 0777)) {
	    print STDERR "ArchiveCommit: Could not mkdir merge.$$: $!\n";
	    goto bad;
	}
	chdir("merge.$$");
	
782
	#
783
	# Check out the current trunk.
784
	#
785 786 787
	mysystem("$SVN checkout $svnopt file://$repodir/$view/trunk")
	    == 0 or goto bad;

788
	#
789 790 791 792 793 794 795 796 797 798
	# 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;
799

800
	mysystem("$SVN commit $svnopt $message_arg trunk")
801
	    == 0 or goto bad;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
802 803 804 805 806 807 808

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

811
    # Create a tag in the tags directory for the commit.
812
    mysystem("$SVN copy $svnopt $message_arg ".
813 814 815 816
	     "          file://$repodir/$view/trunk ".
	     "          file://$repodir/$view/tags/${newtag}")
	== 0 or goto bad;
    
Leigh B. Stoller's avatar
Leigh B. Stoller committed
817 818 819
    # 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.
820
    mysystem("$SVN copy $svnopt $message_arg ".
Leigh B. Stoller's avatar
Leigh B. Stoller committed
821 822 823 824
	     "          file://$repodir/$view/trunk ".
	     "          file://$repodir/$view/history/${newtag}")
	== 0 or goto bad;
    
825
    # Create a branch tag in the tags directory to base differences against.
826
    mysystem("$SVN copy $svnopt -m 'ArchiveCommit Branch' ".
827 828 829
	     "          file://$repodir/$view/trunk ".
	     "          file://$repodir/$view/tags/${newtag}-branch")
	== 0 or goto bad;
830 831 832 833

    # For putting message into DB.
    my $dclause = (defined($mfile) ? 
		   ", description=" . DBQuoteSpecial(`cat $mfile`) : "");
834
    
835
    DBQueryWarn("insert into archive_tags set idx=NULL, ".
836
		"  tag='$newtag', view='$view', ".
837
		"  archive_idx='$archive_idx', ".
838 839
		"  tagtype='$TAGTYPE_COMMIT', ".
		"  date_created=UNIX_TIMESTAMP(now()) $dclause")
840
	or goto bad;
841

842
    DBQueryWarn("update archive_views set ".
843
		"  current_tag='$newtag', ".
844
		"  previous_tag='$archive_tag' ".
845 846
		"where archive_idx='$archive_idx' and view='$view'")
	or goto bad;
847

848 849 850
    # And now into the checkout dir to checkout a current copy.
    if (! chdir("$checkout")) {
	print STDERR "ArchiveCommit: Cannot chdir to $checkout!\n";
851
	goto bad;
852
    }
853
    mysystem("$SVN $svnopt update trunk");
854
    if ($?) {
855
	print STDERR "ArchiveCommit: Could not update head revision!\n";
856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875
	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.
#
876
sub ArchiveFork($$;$$$)
877
{
878 879
    my ($archive_idx, $newview, $branchtag, $newtag, $view) = @_;
    my $sourcepoint;
880 881 882 883 884 885
    my $cwd;

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

    return -1
886
	if (TBScriptLock("archive_${archive_idx}_${view}", 0, 600) !=
887 888 889 890 891 892 893
	    TBSCRIPTLOCK_OKAY());

    #
    # See if the archive exists and if it does, get the pathname to it.
    #
    my $directory;
    if (GetArchiveDirectory($archive_idx, \$directory) < 0) {
894
	print STDERR "ArchiveFork: ".
895 896 897 898
	    "Archive '$archive_idx' does not exist in the DB!\n";
	goto bad;
    }
    if (! -d $directory || ! -w $directory) {
899
	print STDERR "ArchiveFork: $directory cannot be written!\n";
900
	goto bad;
901
    }
902
    my $repodir     = "$directory/repo";
903 904 905 906 907 908 909 910 911 912 913 914 915
    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
916
	print STDERR "ArchiveFork: Bad data in $cwd!\n";
917 918 919 920
	goto bad;
    }

    # Get the current tags for the archive.
921
    my ($archive_tag, $previous_tag);
922
    if (GetArchiveCurrentTags($archive_idx, $view, \$archive_tag,
923
			      \$previous_tag) < 0) {
924
	print STDERR "ArchiveFork: ".
925 926 927 928
	    "Archive '$archive_idx' does not have a current tag!\n";
	goto bad;
    }

929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944
    #
    # 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;
    }

945 946
    # Create new view directories and checkout.
    if (! mkdir("$newcheckin", 0777)) {
947
	print STDERR "ArchiveFork: Could not mkdir $newcheckin: $!\n";
948 949 950
	goto bad;
    }
    if (! chmod(0777, "$newcheckin")) {
951
	print STDERR "ArchiveFork: Could not chmod $newcheckin: $!\n";
952 953
	goto bad;
    }
954 955

    # Create newview directory in the repo.
956
    mysystem("$SVN mkdir $svnopt -m 'ArchiveFork' ".
957 958 959
	     "          file://$repodir/$newview")
	== 0 or goto bad;

960 961 962 963 964 965 966 967 968 969 970 971
    #
    # 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;
972
    }
973
    $sourcepoint = "tags/$branchtag";
974 975 976 977 978 979 980

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

981 982 983 984 985 986 987
    # 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.
988
    mysystem("$SVN mkdir $svnopt -m 'ArchiveFork' ".
989
	     "          file://$repodir/$newview/history ".
990 991 992
	     "          file://$repodir/$newview/tags")
	== 0 or goto bad;

993 994 995 996 997
    # 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;
998 999 1000 1001 1002 1003 1004 1005

    # 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;
1006
    
1007
    # Now check it out. This creates the checkouts/$newview directory.
1008
    mysystem("cd $checkouts; ".
1009
	     "$SVN checkout $svnopt file://$repodir/$newview")
1010 1011
	== 0 or goto bad;

1012 1013 1014 1015
    # Now enter the newview (okay, branch) of this archive.
    DBQueryWarn("insert into archive_views set ".
		"  current_tag='$newtag', archive_idx='$archive_idx', ".
		"  view='$newview', "</