template_instantiate.in 21.2 KB
Newer Older
1 2 3
#!/usr/bin/perl -wT
#
# EMULAB-COPYRIGHT
4
# Copyright (c) 2006, 2007 University of Utah and the Flux Group.
5 6 7
# All rights reserved.
#
use English;
8
use strict;
9
use Getopt::Std;
10
use POSIX qw(setsid);
11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30
use POSIX qw(strftime);
use Errno qw(EDQUOT);
use XML::Simple;
use Data::Dumper;

#
# Create a new experiment template. 
#
# Exit codes are important; they tell the web page what has happened so
# it can say something useful to the user. Fatal errors are mostly done
# with die(), but expected errors use this routine. At some point we will
# use the DB to communicate the actual error.
#
# $status < 0 - Fatal error. Something went wrong we did not expect.
# $status = 0 - Everything okay.
# $status > 0 - Expected error. User not allowed for some reason. 
# 
sub usage()
{
    print(STDERR
Leigh B. Stoller's avatar
Leigh B. Stoller committed
31
	  "Usage: template_instantiate [-q] [-w] [-s]\n".
32 33 34
	  "         [-S reason] [-L reason] [-a <time>] [-l <time>] ".
	  "-e <eid> <guid/vers>\n".
	  "switches and arguments:\n".
35
	  "-b       - batchmode; insert into batch queue\n".
36
	  "-p       - preload only; do not swapin\n".
37 38
	  "-w       - wait for template to be instantiated\n".
	  "-q       - be less chatty\n".
39
	  "-E <str> - A pithy sentence describing the instance\n".
40
	  "-x <file>- XML file of parameter bindings\n".
41 42 43 44 45 46 47 48 49 50
	  "-S <str> - Instance cannot be swapped; must provide reason\n".
	  "-L <str> - Instance cannot be IDLE swapped; must provide reason\n".
	  "-n       - Do not send idle email (internal option only)\n".
	  "-a <nnn> - Auto swapout nnn minutes after instance is swapped in\n".
	  "-l <nnn> - Auto swapout nnn minutes after instance goes idle\n".
	  "-s       - Save disk state on swapout\n".
	  "-e <eid> - The instance name (unique, alphanumeric, no blanks)\n".
	  "<guid/vers> - GUID and version to swapin\n");
    exit(-1);
}
51
my $optlist	 = "qwe:S:L:na:l:se:x:bE:t:r:fp";
52 53 54
my %options      = ();
my $quiet        = 0;
my $waitmode     = 0;
55
my $batchmode    = 0;
56
my $foreground   = 0;
57
my $preload      = 0;
58
my $description;
59 60 61
my $paramfile;
my $guid;
my $version;
62 63
my $eid;
my %parameters   = ();
64 65 66 67 68 69 70 71 72 73 74

#
# Configure variables
#
my $TB		= "@prefix@";
my $EVENTSYS	= @EVENTSYS@;
my $TBOPS	= "@TBOPSEMAIL@";
my $TBLOGS	= "@TBLOGSEMAIL@";
my $TBDOCBASE	= "@TBDOCBASE@";
my $TBBASE	= "@TBBASE@";
my $CONTROL	= "@USERNODE@";
75
my $BOSSNODE    = "@BOSSNODE@";
76
my $OPSDBSUPPORT= @OPSDBSUPPORT@;
77
my $STAMPS      = @STAMPS@;
78 79

# Locals
80
my $EVhandle;
81
my $exptidx;
82 83
my $template;
my $instance;
84
my $logfile;
85
my $template_tag;
86
my @ExptStates  = ();
87 88 89 90
# For the END block below.
my $cleaning    = 0;
my $exptcreated = 0;
my $justexit    = 1;
91 92 93 94 95
# For replay
my $replay_exptidx;	# Instance to replay.
my $replay_runidx;	# Optional run within instance to replay.
my $replay_instance;	# Replay a complete instance, from first run.
my $replay_run;	        # Replay starting with a particular run in instance.
96 97 98 99

# Programs we need
my $checkquota  = "$TB/sbin/checkquota";
my $batchexp    = "$TB/bin/batchexp";
100
my $swapin      = "$TB/bin/template_swapin";
101
my $endexp      = "$TB/bin/endexp";
102
my $dbcontrol   = "$TB/sbin/opsdb_control";
103
my $archcontrol = "$TB/bin/archive_control";
104 105
my $CVSBIN      = "/usr/bin/cvs";
my $RLOG        = "/usr/bin/rlog";
106 107 108 109 110

# Protos
sub ParseArgs();
sub fatal($$);
sub sighandler($);
111
sub SetupEventHandler();
112 113 114 115 116 117 118 119

#
# Testbed Support libraries
#
use lib "@prefix@/lib";
use libdb;
use libtestbed;
use libtblog;
120
use Template;
121
use Experiment;
122
use User;
123
use event;
124
use libaudit;
125

126 127
# In libdb
my $projroot = PROJROOT();
128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150

#
# Turn off line buffering on output
#
$| = 1;

#
# Set umask for start/swap. We want other members in the project to be
# able to swap/end experiments, so the log and intermediate files need
# to be 664 since some are opened for append.
#
umask(0002);

#
# Untaint the path
#
# un-taint path
$ENV{'PATH'} = '/bin:/usr/bin:/usr/local/bin';
delete @ENV{'IFS', 'CDPATH', 'ENV', 'BASH_ENV'};

#
# Verify user and get his DB uid.
#
151 152 153
my $this_user = User->ThisUser();
if (! defined($this_user)) {
    tbdie("You ($UID) do not exist!");
154
}
155 156 157 158
my $user_dbid  = $this_user->dbid();
my $user_uid   = $this_user->uid();
my $user_name  = $this_user->name();
my $user_email = $this_user->email();
159 160 161 162 163

#
# Before doing anything else, check for overquota ... lets not waste
# our time. Make sure user sees the error by exiting with 1.
#
164
if (system("$checkquota $user_uid") != 0) {
165 166
    tberror("You are over your disk quota on $CONTROL; ".
	    "please login there and cleanup!");
167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182
    exit(1);
}

# Now parse arguments.
ParseArgs();

#
# In wait mode, block SIGINT until we spin off the background process.
#
if ($waitmode) {
    $SIG{QUIT} = 'IGNORE';
    $SIG{TERM} = 'IGNORE';
    $SIG{INT}  = 'IGNORE';
}

#
183
# Grab template and do access check.
184
#
185
$template = Template->Lookup($guid, $version);
186

187 188 189
if (!defined($template)) {
    tbdie("Experiment template $guid/$version does not exist!");
}
190 191 192 193 194
my $project = $template->GetProject();
if (!defined($project)) {
    tbdie("Could not get project for $template");
}
if (! $project->AccessCheck($this_user, TB_PROJECT_CREATEEXPT)) {
195 196 197 198 199
    tberror("You do not have permission to instantiate template ".
	    "$guid/$version");
    exit(1);
}

200 201 202 203
if ($STAMPS) {
    $template->Stamp("template_instantiate", "start");
}

204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219
#
# Grab instance and/or run if this is a replay.
#
if (defined($replay_exptidx)) {
    $replay_instance =
      Template::Instance->LookupByExptidx($replay_exptidx);

    if (!defined($replay_instance)) {
	tbdie("Replay Instance $replay_exptidx does not exist!");
    }

    if (!defined($replay_runidx)) {
	#
	# Default to first run.
	#
	# XXX Need to convert these other routines to return Run objects
220 221 222 223 224 225
	$replay_run = $replay_instance->FirstRun();
    }
    else {
	$replay_run =
	    Template::Instance::Run->LookupByID($replay_exptidx,
						$replay_runidx);
226 227 228 229 230 231 232
    }

    if (!defined($replay_run)) {
	tbdie("Replay Run $replay_runidx does not exist!");
    }
}

233 234
#
# If we have a parameter file, we need to copyin the values and store
235 236
# them in the DB for this experiment. Note that these override existing
# values, so we start with those first.
237 238 239 240
#
# XXX Do we keep these values in the DB forever? Or just keep the XML file
# around and archived? 
#
241 242 243
$template->FormalParameterList(\%parameters) == 0
    or tbdie("Could not get formal parameter list for $template");

244 245 246 247 248
if (defined($paramfile)) {
    my $donebad = 0;
    
    my $parse  = XMLin($paramfile,
		       VarAttr => 'name',
249
		       ForceArray => ['parameter'],
250 251 252 253
		       ContentKey => '-content',
		       SuppressEmpty => undef);

    foreach my $name (keys(%{ $parse->{'parameter'} })) {
254
	my $value = $parse->{'parameter'}->{"$name"}->{'value'};
255 256 257 258 259 260 261 262 263 264 265 266 267 268 269

	if (! TBcheck_dbslot($name,
			     "experiment_template_instance_bindings", "name",
			     TBDB_CHECKDBSLOT_WARN|TBDB_CHECKDBSLOT_ERROR)) {
	    tberror("Illegal characters in parameter name: $name");
	    $donebad++;
	}
	if (defined($value) &&
	    ! TBcheck_dbslot($value,
			     "experiment_template_instance_bindings", "value",
			     TBDB_CHECKDBSLOT_WARN|TBDB_CHECKDBSLOT_ERROR)) {
	    tberror("Illegal characters in parameter value: $value");
	    $donebad++;
	}
	# DB records inserted below, once experiment is pre-loaded.
270 271 272
	# Watch for unwanted parameters.
	$parameters{$name} = $value
	    if (exists($parameters{$name}));
273 274 275 276 277 278
    }
    # User sees this error.
    exit(1)
	if ($donebad);
}

279
#
280
# Generate a new template instance record.
281 282
# We will finish updating it later.
#
283
$instance = $template->NewInstance($eid, $this_user, $description);
284
if (!defined($instance)) {
285 286 287
    fatal(-1, "Could not insert new experiment instance record!");
}

288 289 290 291 292 293
#
# At this point, we need to force a cleanup no matter how we exit.
# See the END block below.
#
$justexit = 0;

294 295 296 297
if ($STAMPS) {
    $instance->Stamp("template_instantiate", "created");
}

298
#
299 300
# Now insert the binding records for the instance so that the parser
# can get them.
301 302 303 304 305
#
if ($paramfile) {
    foreach my $name (keys(%parameters)) {
	my $value = $parameters{$name};

306 307
	$instance->NewBinding($name, $value) == 0
	    or fatal(-1, "Error inserting binding into DB!");
308 309
    }
}
310 311
elsif (defined($replay_instance)) {
    #
312 313 314
    # Bindings come from the replay instance (well, run), although the
    # use can still have provided a parameter file (above) to override
    # the values from the record. 
315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332
    #
    my %replay_bindings = ();

    $replay_run->BindingList(\%replay_bindings) == 0
	or fatal(-1, "Error getting bindings from $replay_run!");

    foreach my $name (keys(%replay_bindings)) {
	my $value = $replay_bindings{$name};

	# Insert into new instance now, for the parser to pick up.
	$instance->NewBinding($name, $value) == 0
	    or fatal(-1, "Error inserting binding into DB!");

	# These are used below for inserting the run bindings.
	$parameters{$name} = $value
	    if (exists($parameters{$name}));
    }
}
333

334
#
335 336
# We make a copy of either the underlying template experiment, or of the
# replay argument.
337
#
338 339
my $pid    = $template->pid();
my $copyid = $template->pid() . "," . $template->eid();
340

341 342 343 344 345 346 347 348
#
# Ah, but if this is a replay, then the copyid is really a tag in a
# previous experiment. 
#
if (defined($replay_instance)) {
    $copyid = $replay_instance->exptidx() . ":" . $replay_run->start_tag();
}

349 350 351 352 353 354 355 356 357
#
# Go to the background now so we have a proper log of what happened.
#
#
$SIG{TERM} = \&sighandler;

#
# Use the logonly option to audit so that we get a record mailed.
#
358
if (! $foreground) {
359 360
    $logfile = $instance->CreateLogFile("swapin");
    if (!defined($logfile)) {
361 362
	fatal(-1, "Could not create logfile!");
    }
363 364
    # Mark it open, since it exists.
    $logfile->Open();
365

366
    if (my $childpid = AuditStart(LIBAUDIT_DAEMON, $logfile->filename(),
367
			  LIBAUDIT_LOGONLY|LIBAUDIT_NODELETE|LIBAUDIT_FANCY)) {
368 369 370 371 372 373 374
	#
	# Parent exits normally, unless in waitmode. We have to set
	# justexit to make sure the END block below does not run.
	#
	$justexit = 1;

	if (!$waitmode) {
375 376 377 378 379
	    my $idx = $instance->idx();

	    # XXX The web interface depends on this line.
	    print("Instance $pid/$eid ($idx) is now being instantiated.\n")
		if (! $quiet);
380 381
	    exit(0);
	}
382
	print("Waiting for instance $pid/$eid to fully instantiate.\n")
383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411
	    if (! $quiet);
	    
	if (-t STDIN && !$quiet) {
	    print("You may type ^C at anytime; you will be notified via ".
		  "email.\n".
		  "You will not actually interrupt the instantiation.\n");
	}
	
	# Give child a chance to run.
	select(undef, undef, undef, 0.25);
	
	#
	# Reset signal handlers. User can now kill this process, without
	# stopping the child.
	#
	$SIG{TERM} = 'DEFAULT';
	$SIG{INT}  = 'DEFAULT';
	$SIG{QUIT} = 'DEFAULT';

	#
	# Wait until child exits or until user gets bored and types ^C.
	#
	waitpid($childpid, 0);
	
	print("Done. Exited with status: $?\n")
	    if (! $quiet);
	exit($? >> 8);
    }
    TBdbfork();
Kevin Atkinson's avatar
Kevin Atkinson committed
412 413 414 415 416 417 418

    # Add audit info.  Right now this will only work when called in
    # the child of the script being audited.  Eventually these can be
    # set anywhere.
    AddAuditInfo("which", "$pid/$eid");
    AddAuditInfo("failure_frag", "T. Instantiation Failure");
    AddAuditInfo("success_frag", "New T. Instance Created");
419 420
}

421 422 423 424
if ($STAMPS) {
    $instance->Stamp("template_instantiate", "batchexp start");
}

425 426 427 428 429 430 431 432 433
#
# Build up arguments to batchexp. I do not want to bother with shell
# escapes, hence the list argument to system instead of a long string.
# Be sure to leave it this way, or perl will invoke a shell and that
# would be a really bad thing.
#
# Note special -x option.
#
my @arguments =
434 435
    ($batchexp, "-x", "$guid/$version,$guid/$version",
     "-y", $instance->idx(), "-q", "-f",
436
     "-p", $pid, "-e", $eid, "-g", $template->gid(),
437
     "-E", "'Experiment Template Instantiation $guid/$version' ",
438
     "-c" , $copyid);
439

440 441 442
# All the other goo.
push(@arguments, "-i")
    if (!$batchmode);
443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465
push(@arguments, "-s")
    if (defined($options{"s"}));
push(@arguments, "-n")
    if (defined($options{"n"}));
push(@arguments, ("-S", $options{"S"}))
    if (defined($options{"S"}));
push(@arguments, ("-L", $options{"L"}))
    if (defined($options{"L"}));
push(@arguments, ("-l", $options{"l"}))
    if (defined($options{"l"}));
push(@arguments, ("-a", $options{"a"}))
    if (defined($options{"a"}));
push(@arguments, ("-t", $options{"t"}))
    if (defined($options{"t"}));

# Now invoke batchexp.
system(@arguments);
fatal($? >> 8, "Could not pre-instantiate the experiment")
    if ($?);

# Need to kill the experiment if we fail after this point.
$exptcreated = 1;

466 467 468 469
if ($STAMPS) {
    $instance->Stamp("template_instantiate", "batchexp done");
}

470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491
# Grab the experiment record for below.
my $experiment = Experiment->Lookup($pid, $eid);
if (!defined($experiment)) {
    fatal(-1, "Experiment $pid/$eid could not be found after creation!");
}
$exptidx = $experiment->idx();

#
# Templates always get a DB; override the NS file setting of dpdb, and
# then call out to have it created.
#
if ($OPSDBSUPPORT) {
    my %args = ();
    
    $args{'dpdb'} = 1;

    $experiment->Update(\%args) == 0
	or fatal(-1, "Could not update experiment record!");
    
    if (system("$dbcontrol addexpdb $pid $eid")) {
	fatal(-1, "$dbcontrol addexpdb failed!");
    }
492
    $experiment->Refresh();
493 494
}

495
#
496 497 498
# Need the current archive tag so that we can mark the new instance
# with the the corresponding state of the archive.
# 
499 500 501 502
libArchive::TBExperimentArchiveTag($template->pid(),
				   $template->eid(), \$template_tag) == 0
    or fatal(-1, "Could not get current tag for $template");

503 504 505
#
# Update the Instance
#
506
my %args = ();
507 508
$args{'exptidx'}      = $exptidx;
$args{'template_tag'} = $template_tag;
509

510 511
$instance->Update(0, \%args) == 0
    or fatal(-1, "Could not update experiment instance record!");
512

513 514
my $workdir = $experiment->WorkDir();
my $userdir = $experiment->UserDir();
515 516

#
517
# Now we stash the parameter file.
518 519
#
if ($paramfile) {
520
    system("/bin/cp", $paramfile, $userdir . "/parameters.xml") == 0
521 522 523
	or tbdie("Could not copy out $paramfile");
}

524
#
525 526
# Grab a checkout of the datastore and place it into the exp directory.
# This is essentially a copy.
527
#
528
my $instance_path = $userdir;
529 530

#
531 532 533 534 535 536 537 538 539
# Using the repository now ... the archive will eventually go away.
#
my $cvstag  = "T${guid}-${version}";
my $cvsdir  = "$projroot/$pid/templates/$guid/cvsrepo";

#
# But if this is a replay, then use the tag corresponding to the
# run being replayed, so that we get the datastore that was in
# place when the run was, well, originally run.
540 541
#
if (defined($replay_instance)) {
542 543 544 545 546 547 548 549 550
    $cvstag = "T${guid}-" . $replay_instance->vers();
}
my $revision = `$RLOG -h $cvsdir/setup/.template,v | grep '${cvstag}:'`;

if (! $?) {
    print "Checking out a copy of the template datastore ($cvstag)\n";
    System("cd $instance_path; $CVSBIN -d $cvsdir ".
	   "    checkout -r '$cvstag' -d datastore setup/datastore")
	== 0 or fatal(-1, "Could not checkout from $cvsdir");
551 552 553 554 555 556 557 558 559 560

    System("cd $instance_path; $CVSBIN -d $cvsdir ".
	   "    checkout -r '$cvstag' -d . setup/.template")
	== 0 or fatal(-1, "Could not checkout from $cvsdir");

    # Want this file to be a sandbox file.
    unlink("$instance_path/tbdata/nsfile.ns");
    System("cd $instance_path; $CVSBIN -d $cvsdir ".
	   "    checkout -r '$cvstag' -d tbdata setup/tbdata")
	== 0 or fatal(-1, "Could not checkout from $cvsdir");
561
}
562 563
else {
    my $datastore_tag = $template_tag;
564

565 566 567 568 569 570 571 572 573 574 575 576 577 578
    #
    # But if this is a replay, then use the tag corresponding to the
    # run being replayed, so that we get the datastore that was in
    # place when the run was, well, originally run.
    #
    if (defined($replay_instance)) {
	$datastore_tag = $replay_run->start_tag();
    }

    print "Checking out a copy of the template datastore ($datastore_tag)\n";
    $instance->CopyDataStore($datastore_tag,
			     "$instance_path", $replay_instance) == 0
        or fatal(-1, "Could not copy datastore to instance");
}
579

580
# Ditto for dynamic events. 
581 582 583
$instance->CopyTemplateEvents() == 0
    or fatal(-1, "Could not copy template events to instance");

584
if (! $preload) {
585 586 587 588
    if ($STAMPS) {
	$instance->Stamp("template_instantiate", "swapin starting");
    }
    
589
    #
590
    # Now do the swapin (or it gets queued if a batch experiment).
591
    #
592 593 594
    system("$swapin -w -f -e $eid $guid/$version");
    if ($?) {
	fatal(-1, "Could not swapin instance $instance!");
595
    }
596
}
597
else {
598 599 600 601
    if ($STAMPS) {
	$instance->Stamp("template_instantiate", "preload commit");
    }
    
602 603 604 605 606 607 608 609
    #
    # Lets commit the experiment archive now. The experiment might already
    # be running, but thats not a big deal.
    #
    system("$archcontrol -t instantiate commit $pid $eid");
    if ($?) {
	fatal(-1, "Could not commit archive!");
    }
610
}
611

612 613 614 615
if ($STAMPS) {
    $instance->Stamp("template_instantiate", "done");
}

616
# Stop the web interface from spewing.
617 618
$logfile->Close()
    if (defined($logfile));
619

620
# Email is sent from libaudit at exit ...
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 663 664 665 666 667 668 669 670 671 672 673
exit(0);

#
# Parse command arguments. Once we return from getopts, all that are
# left are the required arguments.
#
sub ParseArgs()
{
    if (! getopts($optlist, \%options)) {
	usage();
    }

    if (@ARGV != 1) {
	usage();
    }
    #
    # Pick up guid/version first and untaint.
    #
    my $tmp = shift(@ARGV);

    if ($tmp =~ /^([\w]*)\/([\d]*)$/) {
	$guid = $1;
	$version = $2;
    }
    else {
	tbdie("Bad data in argument: $tmp");
    }

    if (defined($options{"e"})) {
	$eid = $options{"e"};

	if ($eid =~ /^([-\w]+)$/) {
	    $eid = $1;
	}
	else {
	    tbdie("Bad data in argument: $eid.");
	}
	if (! TBcheck_dbslot($eid, "experiments", "eid",
			   TBDB_CHECKDBSLOT_WARN|TBDB_CHECKDBSLOT_ERROR)) {
	    tbdie("Improper experiment name (id)!");
	}
    }
    else {
	tberror("Must provide an experiment ID (-e option)!");
	exit(1);
    }

    if (defined($options{"q"})) {
	$quiet = 1;
    }
    if (defined($options{"w"})) {
	$waitmode = 1;
    }
674 675 676
    if (defined($options{"f"})) {
	$foreground = 1;
    }
677 678 679
    if (defined($options{"p"})) {
	$preload = 1;
    }
680 681 682
    if (defined($options{"b"})) {
	$batchmode = 1;
    }
683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708
    if (defined($options{"S"})) {
	if ($options{"S"} =~ /^(.*)$/) {
	    $options{"S"} = $1;
	}
    }
    if (defined($options{"L"})) {
	if ($options{"L"} =~ /^(.*)$/) {
	    $options{"L"} = $1;
	}
    }
    if (defined($options{"l"})) {
	if ($options{"l"} =~ /^(.*)$/) {
	    $options{"l"} = $1;
	}
    }
    if (defined($options{"a"})) {
	if ($options{"a"} =~ /^(.*)$/) {
	    $options{"a"} = $1;
	}
    }
    if (defined($options{"t"})) {
	if ($options{"t"} =~ /^(.*)$/) {
	    $options{"t"} = $1;
	}
    }

709 710
    if (defined($options{"x"})) {
	my $inputfile = $options{"x"};
711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733

	# Note different taint check (allow /).
	if ($inputfile =~ /^([-\w\.\/]+)$/) {
	    $inputfile = $1;
	}
	else {
	    tbdie("Bad data in parameter file: $inputfile");
	}

	#
	# Called from ops interactively. Make sure NS file in /proj or /users.
	#
	# Use realpath to resolve any symlinks.
	#
	my $translated = `realpath $inputfile`;
	if ($translated =~ /^([-\w\.\/]+)$/) {
	    $inputfile = $1;
	}
	else {
	    tbdie("Bad data returned by realpath: $translated");
	}

	#
734 735 736 737 738 739
	# The file must reside in an acceptible location. Since this script
	# runs as the caller, regular file permission checks ensure it is a
	# file the user is allowed to use.  So we don't have to be too tight
	# with the RE matching /tmp and /var/tmp files.  These .xml files
	# are allowed since this script is invoked directly from web interface
	# which generates a name that should not be guessable.
740 741 742 743
	#
	if (! ($inputfile =~ /^\/tmp\/[-\w]+-\d+\.xml/) &&
	    ! ($inputfile =~ /^\/tmp\/\d+\.xml/) &&
	    ! ($inputfile =~ /^\/var\/tmp\/php\w+/) &&
744
	    ! TBValidUserDir($inputfile, 0)) {
745 746 747 748 749 750
	    tberror("$inputfile does not resolve to an allowed directory!");
	    # Note positive status; so error goes to user not tbops.
	    exit(1);
	}
	$paramfile = $inputfile;
    }
751 752 753

    if (defined($options{"E"})) {
	if (! TBcheck_dbslot($options{"E"},
754
			     "experiment_template_instances", "description",
755 756 757 758 759
			     TBDB_CHECKDBSLOT_WARN|TBDB_CHECKDBSLOT_ERROR)) {
	    tbdie("Improper template description!");
	}
	$description = $options{"E"};
    }
760 761 762 763 764 765 766 767 768 769 770 771 772 773 774

    if (defined($options{"r"})) {
	my $replay_option = $options{"r"};

	if ($replay_option =~ /^([\d]+)$/) {
	    $replay_exptidx = $1;
	}
	elsif ($replay_option =~ /^([\d]+):([\d]+)$/) {
	    $replay_exptidx = $1;
	    $replay_runidx  = $2;
	}
	else {
	    tbdie("Bad data in argument: $replay_option");
	}
    }
775 776 777 778 779 780 781
}

#
# Cleanup the mess.
#
sub cleanup()
{
782
    if (defined($experiment)) {
783 784
	# Before killing it, save off the user directory for debugging.
	$experiment->BackupUserData();
785

786
	$experiment->End("-f") == 0
787
	    or exit(-1);
788
    }
789 790
    # The web interface will stop spewing when the instance is deleted
    # cause instance Delete removes the logfile entry too.
791 792
    $instance->Delete()
	if (defined($instance));
793

794 795 796 797 798
    #
    # Cleanup DB state for the experiment now that instance is gone.
    #
    $experiment->Delete()
	if (defined($experiment));
799 800 801 802 803 804 805 806 807 808 809 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
}

sub fatal($$)
{
    my ($errorstat, $msg) = @_;
    
    tberror $msg;
    tbinfo "Cleaning up and exiting with status $errorstat ...";

    #
    # This exit will drop into the END block below.
    # 
    exit($errorstat);
}

sub sighandler ($) {
    my ($signame) = @_;
    
    $SIG{TERM} = 'IGNORE';
    my $pgrp = getpgrp(0);
    kill('TERM', -$pgrp);
    sleep(1);
    fatal(-1, "Caught SIG${signame}! Killing experiment setup ...");
}

END {
    # Normal exit, nothing to do.
    if (!$? || $justexit) {
	return;
    }
    my $saved_exitcode = $?;
    
    if ($cleaning) {
	#
	# We are screwed; a recursive error. Someone will have to clean
	# up by hand. 
	#
836 837
	SENDMAIL($TBOPS, 
		 "Template Creation Failure: $pid/$eid",
838 839 840 841 842 843 844 845 846
		 "Recursive error in cleanup! This is very bad.");
	$? = $saved_exitcode;
	return;
    }
    $cleaning = 1;
    cleanup();
    $? = $saved_exitcode;
}