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

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

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

# Must come after package declaration!
use lib '@prefix@/lib';
use libdb;
use libtestbed;
use libtblog;
use English;
24
use overload ('""' => 'Stringify');
25 26 27 28

# Configure variables
my $TB		= "@prefix@";
my $MD5         = "/sbin/md5";
29
my $makegraph   = "$TB/bin/template_graph";
30
my $TEVC	= "$TB/bin/tevc";
31
my $DBCONTROL   = "$TB/sbin/opsdb_control";
32
my $RSYNC	= "/usr/local/bin/rsync";
33

34 35
# Cache of template instances to avoid regenerating them.
my %templates   = ();
Leigh B. Stoller's avatar
Leigh B. Stoller committed
36
my $debug	= 0;
37

38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71
#
# Grab a new GUID for a template. We do not have to use it of course.
#
sub NewGUID($)
{
    my ($pidx) = @_;
    my $idx;
    
    DBQueryFatal("lock tables emulab_indicies write");

    my $query_result = 
	DBQueryFatal("select idx from emulab_indicies ".
		     "where name='next_guid'");
	
    if (! $query_result->num_rows) {
	$idx = 10000;
	
	DBQueryFatal("insert into emulab_indicies (name, idx) ".
		     "values ('next_guid', $idx)");
    }
    else {
	($idx) = $query_result->fetchrow_array();
    }
    my $nextidx = $idx + 1;
    
    DBQueryFatal("update emulab_indicies set idx='$nextidx' ".
		 "where name='next_guid'");

    DBQueryFatal("unlock tables");

    $$pidx = $idx;
    return 0;
}

Leigh B. Stoller's avatar
Leigh B. Stoller committed
72 73 74 75 76 77 78 79 80 81
# Little helper and debug function.
sub mysystem($)
{
    my ($command) = @_;

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

82
#
83
# Lookup a template and create a class instance to return.
84
#
85
sub Lookup($$$)
86
{
87
    my ($class, $guid, $vers) = @_;
88

89 90 91 92
    # Look in cache first
    return $templates{"$guid/$vers"}
        if (exists($templates{"$guid/$vers"}));
    
93
    my $query_result =
94 95
	DBQueryWarn("select * from experiment_templates ".
		    "where guid='$guid' and vers='$vers'");
96

97 98
    return undef
	if (!$query_result || !$query_result->numrows);
99

100 101 102 103 104
    my $self             = {};
    $self->{'TEMPLATE'}  = $query_result->fetchrow_hashref();
    # Filled lazily.
    $self->{'INSTANCES'} = undef;
    bless($self, $class);
105
    
106 107 108 109
    # Add to cache. 
    $templates{"$guid/$vers"} = $self;
    
    return $self;
110
}
111 112 113 114 115 116 117
# accessors
sub guid($) { return ((! ref($_[0])) ? -1 : $_[0]->{'TEMPLATE'}->{'guid'}); }
sub vers($) { return ((! ref($_[0])) ? -1 : $_[0]->{'TEMPLATE'}->{'vers'}); }
sub pid($)  { return ((! ref($_[0])) ? -1 : $_[0]->{'TEMPLATE'}->{'pid'}); }
sub gid($)  { return ((! ref($_[0])) ? -1 : $_[0]->{'TEMPLATE'}->{'gid'}); }
sub eid($)  { return ((! ref($_[0])) ? -1 : $_[0]->{'TEMPLATE'}->{'eid'}); }
sub tid($)  { return ((! ref($_[0])) ? -1 : $_[0]->{'TEMPLATE'}->{'tid'}); }
118
sub path($) { return ((! ref($_[0])) ? -1 : $_[0]->{'TEMPLATE'}->{'path'}); }
119 120
sub archive_idx($) {
    return ((! ref($_[0])) ? -1 : $_[0]->{'TEMPLATE'}->{'archive_idx'}); }
121 122 123 124
sub parent_guid($) {
    return ((! ref($_[0])) ? -1 : $_[0]->{'TEMPLATE'}->{'parent_guid'}); }
sub IsRoot($) {
    return ! defined($_[0]->{'TEMPLATE'}->{'parent_guid'}); }
125 126

#
127
# Lookup a template given an experiment index.
128
#
129
sub LookupByExptidx($$)
130
{
131
    my ($class, $exptidx) = @_;
132

133 134
    # Use the Template Instance routine, and grab the template out of it.
    my $template_instance = Template::Instance->LookupByExptidx($exptidx);
135

136 137
    return undef
	if (!defined($template_instance));
138

139
    return $template_instance->template();
140 141
}

Leigh B. Stoller's avatar
Leigh B. Stoller committed
142
#
143
# Refresh a template instance by reloading from the DB.
Leigh B. Stoller's avatar
Leigh B. Stoller committed
144
#
145
sub Refresh($)
Leigh B. Stoller's avatar
Leigh B. Stoller committed
146
{
147
    my ($self) = @_;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
148

149 150
    return -1
	if (! ref($self));
Leigh B. Stoller's avatar
Leigh B. Stoller committed
151

152 153 154 155 156 157
    my $guid = $self->guid();
    my $vers = $self->vers();
    
    my $query_result =
	DBQueryWarn("select * from experiment_templates ".
		    "where guid='$guid' and vers='$vers'");
Leigh B. Stoller's avatar
Leigh B. Stoller committed
158 159

    return -1
160 161 162
	if (!$query_result || !$query_result->numrows);
	
    $self->{'TEMPLATE'} = $query_result->fetchrow_hashref();
Leigh B. Stoller's avatar
Leigh B. Stoller committed
163 164 165
    return 0;
}

166
#
167 168
# Create a new template. This installs the new record in the DB,
# and returns an instance. There is some bookkeeping along the way.
169
#
170
sub Create($$)
171
{
172 173
    my ($class, $argref) = @_;
    my ($guid, $vers);
174

175 176
    return undef
	if (ref($class));
177

178 179 180 181 182 183 184 185 186 187 188 189 190
    # See if this a child of an existing template.
    if (defined($argref->{'parent_guid'})) {
	$guid = $argref->{'parent_guid'};
    }
    else {
	#
	# Grab a new GUID before we lock other tables.
	#
	if (NewGUID(\$guid) < 0) {
	    tberror("Could not get a new GUID!");
	    return undef;
	}
	$vers = 1;
191 192
    }

193 194 195
    DBQueryWarn("lock tables experiments write, ".
		"            experiment_templates write")
	or return undef;
196

197 198 199 200 201 202 203
    #
    # Find unused version number now that tables are locked. 
    #
    if (! defined($vers)) {
	my $query_result =
	    DBQueryWarn("select MAX(vers) from experiment_templates ".
			"where guid='$guid'");
204

205 206 207 208
	if (!$query_result) {
	    DBQueryWarn("unlock tables");
	    return undef;
	}
209

210 211 212
	$vers = ($query_result->fetchrow_array())[0];
	$vers++;
    }
213

214 215 216 217
    # We make up an eid using the guid and version. This is the eid for the
    # hidden experiment behind each template. 
    my $eid = "T${guid}-${vers}";
    my $pid = $argref->{'pid'};
218

219
    #
220
    # Sanity check; make sure this eid is not in use. Tables are still locked.
221 222
    #
    my $query_result =
223 224
	DBQueryWarn("select pid,eid from experiments ".
		    "where eid='$eid' and pid='$pid'");
225

226 227 228 229 230 231 232 233 234
    if (!$query_result) {
	DBQueryWarn("unlock tables");
	return undef;
    }
    
    if ($query_result->numrows) {
	DBQueryWarn("unlock tables");
	tberror("Experiment ID $eid in project $pid is already in use!");
	return undef;
235 236
    }

237 238
    my $query = "insert into experiment_templates set ".
	join(",", map("$_='" . $argref->{$_} . "'", keys(%{$argref})));
239

240 241
    # Append the rest
    $query .= ",created=now(),guid='$guid',vers='$vers',eid='$eid'";
242

243 244 245 246 247 248 249
    if (! DBQueryWarn($query)) {
	DBQueryWarn("unlock tables");
	return undef;
    }
    DBQueryWarn("unlock tables");

    return Template->Lookup($guid, $vers);
250 251 252
}

#
253
# Stringify for output.
254
#
255
sub Stringify($)
256
{
257 258 259
    my ($self) = @_;
    my $guid   = $self->guid();
    my $vers   = $self->vers();
260

261
    return "[Template: $guid/$vers]";
262 263
}

264
#
265
# Update a template record given an array reference of slot/value pairs.
266
#
267
sub Update($$)
268
{
269
    my ($self, $argref) = @_;
270

271 272 273
    # Must be a real reference. 
    return -1
	if (! ref($self));
274

275 276
    my $guid = $self->guid();
    my $vers = $self->vers();
277

278 279 280 281
    my $query = "update experiment_templates set ".
	join(",", map("$_='" . $argref->{$_} . "'", keys(%{$argref})));

    $query .= " where guid='$guid' and vers='$vers'";
282 283 284

    return -1
	if (! DBQueryWarn($query));
285 286

    return Refresh($self);
287 288
}

289
#
290 291
# Delete a template (all tables). Note that other parts of the template
# like instances must already be gone when this is called.
292
#
293
sub Delete($)
294
{
295
    my ($self) = @_;
296

297
    # Must be a real reference. 
298
    return -1
299
	if (! ref($self));
300

301 302
    my $guid = $self->guid();
    my $vers = $self->vers();
303

304
    DeleteAllMetadata($self) == 0
305
	or return -1;
306

307 308
    DeleteInputFiles($self) == 0
	or return -1;
309

310 311 312 313
    # The graph can be removed if this is the last template version.
    my $query_result =
	DBQueryWarn("select vers from experiment_templates ".
		    "where guid='$guid' and vers!='$vers'");
314 315 316
    return -1
	if (! $query_result);

317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340
    if (! $query_result->numrows) {
	DBQueryWarn("delete from experiment_template_graphs ".
		    "where parent_guid='$guid'")
	    or return -1;
    }

    # Make sure the experiment_templates table is always last, in case
    # something goes wrong. 
    my @tables = ("experiment_template_parameters",
		  "experiment_templates");

    foreach my $table (@tables) {
        if ($table eq "experiment_templates") {
            DBQueryWarn("delete from $table ".
			"where guid='$guid' and vers='$vers'")
		or return -1;
        }
        else {
            DBQueryWarn("delete from $table ".
			"where parent_guid='$guid' and parent_vers='$vers'")
		or return -1;
        }
    }
    $self->{'TEMPLATE'} = undef;
341 342 343
    return 0;
}

344
#
345
# Template permission checks. Using the experiment access check stuff.
346
#
347 348 349
# Usage: AccessCheck($guid, $uid, $access_type)
#	 returns 0 if not allowed.
#        returns 1 if allowed.
350
#
351
sub AccessCheck($$$;$)
352
{
353 354 355 356 357 358 359
    my ($self, $guid, $uid, $access_type);
    my $mintrust;
    
    #
    # If called as a method, no guid argument is provided. 
    #
    $self = shift();
360

361 362 363 364 365
    if (ref($self)) {
	($uid, $access_type) = @_;
    }
    else {
	($guid, $uid, $access_type) = @_;
366

367 368 369 370 371 372 373 374 375
	$self = Template->Lookup($guid, 1);
	return 0
	    if (! $self);
    }
    
    if ($access_type < TB_EXPT_MIN ||
	$access_type > TB_EXPT_MAX) {
	tbdie("Invalid access type: $access_type!");
    }
376

377 378 379 380 381 382 383
    #
    # Admins do whatever they want!
    #
    if (TBAdmin($uid)) {
	return 1;
    }
    $uid = MapNumericUID($uid);
384

385 386
    my $pid = $self->pid();
    my $gid = $self->gid();
387

388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405
    #
    # An experiment may be destroyed by the experiment creator or the
    # project/group leader.
    #
    if ($access_type == TB_EXPT_READINFO) {
	$mintrust = PROJMEMBERTRUST_USER;
    }
    else {
	$mintrust = PROJMEMBERTRUST_LOCALROOT;
    }

    #
    # Either proper permission in the group, or group_root in the project.
    # This lets group_roots muck with other people's experiments, including
    # those in groups they do not belong to.
    #
    return TBMinTrust(TBGrpTrust($uid, $pid, $gid), $mintrust) ||
	TBMinTrust(TBGrpTrust($uid, $pid, $pid), PROJMEMBERTRUST_GROUPROOT);
406 407
}

408
#
409
# Return a list of all children of the given template.
410
#
411
sub Children($$)
412
{
413
    my ($self, $resultp) = @_;
414

415 416 417
    # Must be a real reference. 
    return -1
	if (! ref($self));
418

419 420 421 422 423 424 425 426 427 428
    my $guid      = $self->guid();
    my %children  = ();
    my @allkids   = ();
    my @kids      = ();
    my @result    = ();
    
    my $query_result =
	DBQueryWarn("select vers,parent_vers from experiment_templates ".
		    "where parent_guid='$guid' ".
		    "order by vers desc");
429
    return -1
430
	if (!$query_result);
431

432 433 434
    while (my ($vers, $parent_vers) = $query_result->fetchrow_array()) {
	$children{$parent_vers} = []
	    if (!exists($children{$parent_vers}));
435

436 437 438 439 440 441 442 443 444 445 446 447 448 449
	# List of all children for the parent.
	push(@{ $children{$parent_vers} }, $vers);
    }

    # Start with direct children of this template.
    unshift(@allkids, @{ $children{$self->vers()} })
	if (exists($children{$self->vers()}));

    # Descend the tree getting all children recursively.
    while (@allkids) {
	my $kid   = pop(@allkids);

	# New kid to return
	push(@kids, $kid);
450

451 452 453 454 455 456
	# New children of kid
	unshift(@allkids, @{ $children{$kid} })
	    if (exists($children{$kid}));
    }
    # Most recent templates first.
    @kids = sort {$b <=> $a} @kids;
457

458 459 460 461 462 463 464
    # Now convert to template objects.
    foreach my $vers (@kids) {
	my $template = Template->Lookup($guid, $vers);
	return -1
	    if (! $template);
	push(@result, $template);
    }
465

466
    @$resultp = @result;
467 468 469 470
    return 0;
}

#
471 472 473 474 475
# Add an input file to the template. The point of this is to reduce
# duplication by taking an md5 of the input file, and sharing that
# record/file.
# 
sub AddInputFile($$)
476
{
477 478
    my ($self, $inputfile) = @_;
    my $input_data_idx;
479

480 481 482
    # Must be a real reference. 
    return -1
	if (! ref($self));
483

484
    my $data_string = `cat $inputfile`;
485 486 487
    return -1
	if ($?);

488 489 490 491
    my $guid = $self->guid();
    my $vers = $self->vers();
    my $pid  = $self->pid();
    my $tid  = $self->tid();
492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507

    if ($data_string) {
	# As you can see, we md5 the raw data.
	$data_string = DBQuoteSpecial($data_string);
	if (length($data_string) >= DBLIMIT_NSFILESIZE()) {
	    tberror("Input file is too big (> " . DBLIMIT_NSFILESIZE() . ")!");
	    return -1;
	}

	#
	# Grab an MD5 of the file to see if we already have a copy of it.
	# Avoids needless duplication.
	#
	my $md5 = `$MD5 -q $inputfile`;
	chomp($md5);

508 509 510 511
	DBQueryWarn("lock tables experiment_template_inputs write, ".
		    "            experiment_template_input_data write")
	    or return -1;

512 513 514 515
	my $query_result =
	    DBQueryWarn("select idx from experiment_template_input_data ".
			"where md5='$md5'");

516 517 518 519
	if (!$query_result) {
	    DBQueryWarn("unlock tables");
	    return -1;
	}
520 521

	if ($query_result->numrows) {
522
	    ($input_data_idx) = $query_result->fetchrow_array();
523 524 525 526 527 528 529
	}
	else {
	    $query_result =
		DBQueryWarn("insert into experiment_template_input_data ".
			    "(idx, md5, input) ".
			    "values (NULL, '$md5', $data_string)");
	    
530 531 532 533 534
	    if (!$query_result) {
		DBQueryWarn("unlock tables");
		return -1;
	    }
	    $input_data_idx = $query_result->insertid;
535 536
	}

537 538 539 540
	$query_result =
	    DBQueryWarn("insert into experiment_template_inputs ".
			" (idx, parent_guid, parent_vers, ".
			"  pid, tid, input_idx) values ".
541
			" (NULL, '$guid', '$vers', '$pid', '$tid', ".
542 543
			"  '$input_data_idx')");
	DBQueryWarn("unlock tables");
544
	return -1
545
	    if (!$query_result);
546 547 548 549
    }
    return 0;
}

550
#
551
# Delete all input files, say for a template create/modify that fails.
552
#
553
sub DeleteInputFiles($)
554
{
555
    my ($self) = @_;
556

557 558 559 560 561 562 563
    # Must be a real reference. 
    return -1
	if (! ref($self));

    my $guid = $self->guid();
    my $vers = $self->vers();
    
564 565
    DBQueryWarn("lock tables experiment_template_inputs as i write, ".
		"            experiment_template_inputs as j write, ".
Leigh B. Stoller's avatar
Leigh B. Stoller committed
566
		"            experiment_template_inputs write, ".
567 568 569 570 571 572 573 574 575 576 577 578 579 580
		"            experiment_template_input_data write")
	or return -1;

    #
    # The point of this query is to see if any of the input files in this
    # template are shared with some other template, and thus should not
    # be deleted from the input_data table.
    #
    my $query_result =
	DBQueryWarn("select i.idx,i.input_idx,count(j.input_idx) as count ".
		    "   from experiment_template_inputs as i ".
		    "left join experiment_template_inputs as j on ".
		    "     j.input_idx=i.input_idx ".
		    "where i.parent_guid='$guid' and ".
581
		    "      i.parent_vers='$vers' ".
582 583 584 585 586 587 588 589 590 591 592 593 594
		    "group by j.input_idx having count > 1");

    if (! $query_result) {
	DBQueryWarn("unlock tables");
	return -1;
    }

    while (my ($input_idx, $data_idx) = $query_result->fetchrow_array()) {
	DBQueryWarn("delete from experiment_template_input_data ".
		    "where idx='$data_idx'");
    }
    $query_result = 
	DBQueryWarn("delete from experiment_template_inputs ".
595
		    "where parent_guid='$guid' and parent_vers='$vers'");
596 597 598 599 600 601 602 603
    DBQueryWarn("unlock tables");
    
    return -1
	if (! $query_result);

    return 0;
}

604
#
605
# Add a metadata record. 
606
#
607
sub NewMetadata($$$$;$)
608
{
609
    my ($self, $name, $value, $creator, $type) = @_;
610
    my $guid;
611 612
    my $version  = 1;
    my $internal = 0;
613
    my $metadata_type;
614

615
    # Must be a real reference. 
616
    return -1
617 618 619 620 621 622 623 624 625 626
	if (! ref($self));

    my $template_guid = $self->guid();
    my $template_vers = $self->vers();

    return -1
	if (NewGUID(\$guid) < 0);

    # Special ...
    $internal = 1
627
	if (defined($type));
628

629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644
    # Current set of allowed types;
    my @okay_types = ("tid", "template_description", "parameter_description");

    if (defined($type)) {
	if (! grep {$_ eq $type} @okay_types) {
	    tberror("Illegal metadata type: $type");
	    return -1;
	}
	$metadata_type = "'$type'";
    }
    else {
	$metadata_type = "NULL";
    }

    my $safename  = DBQuoteSpecial($name);
    my $safevalue = DBQuoteSpecial($value);
645 646 647

    my $query_result =
	DBQueryWarn("insert into experiment_template_metadata_items set ".
648
		    "   guid='$guid', vers='$version', uid='$creator', ".
649
		    "   template_guid='$template_guid', ".
650
		    "   name=$safename, value=$safevalue, created=now()");
651 652 653 654 655
    return -1
	if (!$query_result);

    DBQueryWarn("insert into experiment_template_metadata set ".
		"   parent_guid='$template_guid', ".
656
		"   parent_vers='$template_vers', ".
657 658
		"   metadata_guid='$guid', ".
		"   metadata_vers='$version', ".
659
		"   metadata_type=$metadata_type, ".
660
		"   internal=$internal")
661
	or return -1;
662 663 664 665 666 667 668 669

    # Some metadata is special ...
    if (defined($type)) {
	if ($type eq "parameter_description") {
	    $query_result =
		DBQueryWarn("update experiment_template_parameters set ".
			    "   metadata_guid='$guid', ".
			    "   metadata_vers='$version' ".
670 671 672
			    "where parent_guid='$template_guid' and ".
			    "      parent_vers='$template_vers' and ".
			    "      name=$safename");
673 674 675 676
	    return -1
		if (!$query_result);
	}
    }
677 678 679 680
    
    return 0;
}

681 682 683
#
# Lookup a metadata value by name, optionally returning guid/vers.
#
684
sub LookupMetadata($$;$$$)
685
{
686
    my ($self, $name, $pguid, $pvers, $ptype) = @_;
687 688 689 690 691 692 693 694 695 696 697

    # Must be a real reference. 
    return -1
	if (! ref($self));

    my $template_guid = $self->guid();
    my $template_vers = $self->vers();

    $name = DBQuoteSpecial($name);

    my $query_result =
698
	DBQueryWarn("select metadata_guid,metadata_vers,metadata_type ".
699 700 701 702 703 704 705 706 707 708 709 710
		    "   from experiment_template_metadata as m ".
		    "left join experiment_template_metadata_items as i on ".
		    "     m.metadata_guid=i.guid and m.metadata_vers=i.vers ".
		    "where m.parent_guid='$template_guid' and ".
		    "      m.parent_vers='$template_vers' and ".
		    "      i.name=$name");
    
    return -1
	if (!$query_result);
    return 0
	if (!$query_result->numrows);

711 712
    my ($metadata_guid, $metadata_vers, $metadata_type) =
	$query_result->fetchrow_array();
713 714 715 716
    $$pguid = $metadata_guid
	if (defined($pguid));
    $$pvers = $metadata_vers
	if (defined($pvers));
717 718
    $$ptype = $metadata_type
	if (defined($ptype));
719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739
    
    return 1;
}

#
# Modify a metadata record; these are versioned of course.
#
sub ModifyMetadata($$$$)
{
    my ($self, $name, $value, $creator) = @_;
    my $guid;
    my $version = 1;

    # Must be a real reference. 
    return -1
	if (! ref($self));

    my $template_guid = $self->guid();
    my $template_vers = $self->vers();
    my $parent_guid;
    my $parent_vers;
740
    my $metadata_type;
741
    my $already_exists =
742 743
	$self->LookupMetadata($name,
			      \$parent_guid, \$parent_vers, \$metadata_type);
744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789
    return -1
	if ($already_exists <= 0);

    $name  = DBQuoteSpecial($name);
    $value = DBQuoteSpecial($value);

    DBQueryWarn("lock tables experiment_template_metadata_items write")
	or return -1;
    
    my $query_result =
	DBQueryWarn("select MAX(vers) ".
		    " from experiment_template_metadata_items ".
		    "where guid='$parent_guid'");
    if (!$query_result) {
	DBQueryWarn("unlock tables");
	return -1;
    }
    my ($metadata_vers) = $query_result->fetchrow_array();
    $metadata_vers++;

    #
    # Insert new item.
    #
    if (!DBQueryWarn("insert into experiment_template_metadata_items set ".
		     "     guid='$parent_guid',vers='$metadata_vers', ".
		     "     template_guid='$template_guid', uid='$creator', ".
		     "     parent_guid='$parent_guid',".
		     "     parent_vers='$parent_vers'," .
		     "     name=$name, value=$value, created=now()")) {
	DBQueryWarn("unlock tables");
	return -1;
    }
    DBQueryWarn("unlock tables");

    if (!DBQueryWarn("update experiment_template_metadata ".
		     "  set metadata_vers='$metadata_vers' ".
		     "where metadata_guid='$parent_guid' and ".
		     "      metadata_vers='$parent_vers'")) {
	DBQueryWarn("delete from experiment_template_metadata_items ".
		    "where guid='$parent_guid',vers='$metadata_vers'");
	return -1;
    }

    #
    # XXX Some metadata is special ...
    #
790 791 792 793 794 795 796 797 798
    if (defined($metadata_type)) {
	if ($metadata_type eq "tid") {
	    DBQueryWarn("update experiment_templates set tid=$value ".
			"where guid='$template_guid' and ".
			"      vers='$template_vers'")
		or return -1;
	    
	    Refresh($self);
	    # This can fail; it is not critical.
Leigh B. Stoller's avatar
Leigh B. Stoller committed
799
	    Template::mysystem("$makegraph $template_guid");
800 801 802 803 804 805 806 807 808 809 810 811 812
	}
	elsif ($metadata_type eq "template_description") {
	    DBQueryWarn("update experiment_templates set description=$value ".
			"where guid='$template_guid' and ".
			"      vers='$template_vers'")
		or return -1;
	    
	    Refresh($self);	
	}
	elsif ($metadata_type eq "parameter_description") {
	    DBQueryWarn("update experiment_template_parameters set ".
			"   metadata_guid='$parent_guid', ".
			"   metadata_vers='$metadata_vers' ".
813 814 815
			"where parent_guid='$template_guid' and ".
			"      parent_vers='$template_vers' and ".
			"      name=$name")
816 817
		or return -1
	}
818 819 820 821 822
    }
    return 0;
}

#
823
# Add a formal parameter to a template.
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
#
sub NewFormalParameter($$$)
{
    my ($self, $name, $value) = @_;

    # Must be a real reference. 
    return -1
	if (! ref($self));

    my $template_guid = $self->guid();
    my $template_vers = $self->vers();
    my $pid = $self->pid();
    my $tid = $self->tid();

    if (defined($value)) {
      $value = DBQuoteSpecial($value);
    }
    else {
      $value = "NULL";
    }

    DBQueryWarn("insert into experiment_template_parameters set ".
		"  parent_guid='$template_guid', ".
		"  parent_vers='$template_vers', ".
		"  pid='$pid', tid='$tid', ".
		"  name='$name', value=$value")
	or return -1;

    return 0;
}

855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884
#
# Get list of template formal parameters.
#
sub FormalParameterList($$)
{
    my ($self, $prval) = @_;

    # Must be a real reference. 
    return -1
	if (! ref($self));

    my %results = ();
    my $template_guid = $self->guid();
    my $template_vers = $self->vers();

    my $query_result =
	DBQueryWarn("select name,value from experiment_template_parameters ".
		    "where parent_guid='$template_guid' and ".
		    "      parent_vers='$template_vers'");

    return -1
	if (!$query_result);

    while (my ($name,$value) = $query_result->fetchrow_array()) {
	$results{$name} = $value;
    }
    %$prval = %results;
    return 0;
}

885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918
#
# Get description for formal parameters; this needs to be its own object.
#
sub FormalParameterDescription($$)
{
    my ($self, $name, $prval) = @_;

    # Must be a real reference. 
    return -1
	if (! ref($self));

    my $result = undef;
    my $template_guid = $self->guid();
    my $template_vers = $self->vers();
    $name = DBQuoteSpecial($name);

    my $query_result =
	DBQueryWarn("select m.value from experiment_template_parameters as p ".
		    "left join experiment_template_metadata_items as m on ".
		    "     m.guid=p.metadata_guid and m.vers=p.metadata_vers ".
		    "where p.parent_guid='$template_guid' and ".
		    "      p.parent_vers='$template_vers' and ".
		    "      p.name=$name");

    return -1
	if (!$query_result);

    if ($query_result->numrows) {
	($result) = $query_result->fetchrow_array();
    }
    $$prval = $result;
    return 0;
}

919
#
920
# Delete (all) template metadata
921
#
922
sub DeleteAllMetadata($)
923
{
924 925 926 927 928 929 930 931
    my ($self) = @_;

    # Must be a real reference. 
    return -1
	if (! ref($self));

    my $template_guid = $self->guid();
    my $template_vers = $self->vers();
932 933 934 935 936

    my $query_result =
	DBQueryWarn("select metadata_guid ".
		    "    from experiment_template_metadata ".
		    "where parent_guid='$template_guid' and ".
937
		    "      parent_vers='$template_vers'");
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

    return -1
	if (!$query_result);

    while (my ($metadata_guid) = $query_result->fetchrow_array()) {
	my @versions = ();

	#
	# Delete all versions for each record. This is wrong if we ever
	# want to share entries between templates.
	#
	my $metadata_result =
	    DBQueryWarn("select vers from experiment_template_metadata_items ".
			"where guid='$metadata_guid'");

	return -1
	    if (!$metadata_result);

	next
	    if (!$metadata_result->numrows);

	while (my ($metadata_vers) = $metadata_result->fetchrow_array()) {
	    push(@versions, $metadata_vers);
	}

	my $clause = join(" or ", map("vers='$_'", @versions));

	DBQueryWarn("delete from experiment_template_metadata_items ".
		    "where guid='$metadata_guid' and ($clause)")
	    or return -1;
    }
    DBQueryWarn("delete from experiment_template_metadata ".
		"where parent_guid='$template_guid' and ".
971
		"      parent_vers='$template_vers'")
972 973 974 975 976
	or return -1;

    return 0;
}

977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018
#
# Delete a specific template metadata item from the template, but we leave
# actual items behind. 
#
sub DeleteMetadata($$)
{
    my ($self, $name) = @_;

    # Must be a real reference. 
    return -1
	if (! ref($self));

    my $template_guid = $self->guid();
    my $template_vers = $self->vers();
    $name = DBQuoteSpecial($name);

    my $query_result =
	DBQueryWarn("select metadata_guid,metadata_vers ".
		    "   from experiment_template_metadata as m ".
		    "left join experiment_template_metadata_items as i on ".
		    "     m.metadata_guid=i.guid and m.metadata_vers=i.vers ".
		    "where m.parent_guid='$template_guid' and ".
		    "      m.parent_vers='$template_vers' and ".
		    "      i.name=$name");
    
    return -1
	if (!$query_result);
    return -1
	if (!$query_result->numrows);

    my ($metadata_guid, $metadata_vers) = $query_result->fetchrow_array();
    
    DBQueryWarn("update experiment_template_metadata set hidden=1 ".
		"where parent_guid='$template_guid' and ".
		"      parent_vers='$template_vers' and ".
		"      metadata_guid='$metadata_guid' and ".
		"      metadata_vers='$metadata_vers'")
	or return -1;

    return 0;
}

1019 1020 1021 1022
#
# Copy exiting template metadata to a child. This is likely to change
# since we probably want to share at some point.
#
1023
sub CopyMetadata($$$)
1024
{
1025
    my ($self, $parent, $copier) = @_;
1026 1027 1028

    # Must be a real reference. 
    return -1
1029
	if (! (ref($self) && ref($parent)));
1030

1031 1032 1033
    my $from_guid = $parent->guid();
    my $from_vers = $parent->vers();
    my $to_vers   = $self->vers();
1034 1035 1036 1037 1038

    #
    # Copy the toplevel items.
    #
    my $query_result =
1039
	DBQueryWarn("select name,value,metadata_type,internal ".
1040 1041 1042 1043 1044
		    "  from experiment_template_metadata as m ".
		    "left join experiment_template_metadata_items as i on ".
		    "     i.guid=m.metadata_guid and ".
		    "     i.vers=m.metadata_vers ".
		    "where m.parent_guid='$from_guid' and ".
1045
		    "      m.parent_vers='$from_vers'")
1046 1047
	or return -1;

1048 1049 1050
    while (my ($name,$value,$type,$internal) =
	   $query_result->fetchrow_array()) {

1051 1052
	my $guid;
	my $version = 1;
1053
	my $metadata_type = "NULL";
1054 1055 1056 1057
	
	$name   = DBQuoteSpecial($name);
	$value  = DBQuoteSpecial($value);

1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070
	#
	# XXX Some metadata is special ...
	#
	if (defined($type)) {
	    # XXX Skip the tid and template descriptions.
	    next
		if ($type eq "tid" or $type eq "template_description");

	    # XXX Skip parameters that were deleted.
	    if ($type eq "parameter_description") {
		my $param_result = 
		    DBQueryWarn("select * ".
				"   from experiment_template_parameters ".
1071 1072 1073
				"where parent_guid='$from_guid' and ".
				"      parent_vers='$to_vers' and ".
				"      name=$name");
1074 1075 1076 1077 1078 1079 1080 1081 1082 1083

		return -1
		    if (!$param_result);
		
		next
		    if (!$param_result->numrows);
	    }
	    $metadata_type = "'$type'";
	}

1084
	return -1
1085
	    if (NewGUID(\$guid) < 0);
1086 1087 1088

	DBQueryWarn("insert into experiment_template_metadata set ".
		    "   parent_guid='$from_guid', ".
1089
		    "   parent_vers='$to_vers', ".
1090 1091
		    "   metadata_guid='$guid', ".
		    "   metadata_vers='$version', ".
1092 1093
		    "   metadata_type=$metadata_type, ".
		    "   internal=$internal")
1094 1095 1096
	    or return -1;

	DBQueryWarn("insert into experiment_template_metadata_items set ".
1097
		    "   guid='$guid', vers='$version', uid='$copier', ".
1098 1099 1100 1101
		    "   template_guid='$from_guid', ".
		    "   name=$name, value=$value, created=now()")
	    or return -1;

1102 1103 1104 1105 1106 1107 1108 1109
	#
	# XXX Some metadata is special ...
	#
	if (defined($type)) {
	    if ($type eq "parameter_description") {
		DBQueryWarn("update experiment_template_parameters set ".
			    "   metadata_guid='$guid', ".
			    "   metadata_vers='$version' ".
1110 1111 1112
			    "where parent_guid='$from_guid' and ".
			    "      parent_vers='$to_vers' and ".
			    "      name=$name")
1113 1114 1115 1116
		    or return -1
		}
	}
    }
1117 1118 1119
    return 0;
}

1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164
#
# Return a list of metadata. This should be its own object.
#
sub MetadataList($$)
{
    my ($self, $prval) = @_;

    # Must be a real reference. 
    return -1
	if (! ref($self));

    my %results = ();

    my $template_guid = $self->guid();
    my $template_vers = $self->vers();

    #
    # Copy the toplevel items.
    #
    my $query_result =
	DBQueryWarn("select i.* from experiment_template_metadata as m ".
		    "left join experiment_template_metadata_items as i on ".
		    "     i.guid=m.metadata_guid and ".
		    "     i.vers=m.metadata_vers ".
		    "where m.parent_guid='$template_guid' and ".
		    "      m.parent_vers='$template_vers' and ".
		    "      m.hidden=0 and m.metadata_type is null")
	or return -1;

    while (my $rowref = $query_result->fetchrow_hashref()) {
	my $name	= $rowref->{"name"};
	my $value       = $rowref->{"value"};
	my $guid	= $rowref->{"guid"};
	my $vers	= $rowref->{"vers"};

	my $ref = {'name'   => $name,
		   'value'  => $value,
		   'guid'   => "$guid/$vers"};

	$results{$name} = $ref;
    }
    %$prval = %results;
    return 0;
}

1165
#
1166
# Create a new Instance record, using the package below.
1167
#
1168
sub NewInstance($$$)
1169
{
1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220
    my ($self, $eid, $creator) = @_;

    # Must be a real reference. 
    return undef
	if (! ref($self));

    # We provide this stuff now.
    my %args = ();
    $args{'parent_guid'} = $self->guid();
    $args{'parent_vers'} = $self->vers();
    $args{'pid'}         = $self->pid();
    $args{'eid'}         = $eid;
    $args{'uid'}         = $creator;

    return Template::Instance->Create(\%args);
}

#
# Generate a list of instances for a template and save in the template
# structure. The argument indicates whether you want just active, or all
# of them (historical).
#
sub InstanceList($$$)
{
    my ($self, $all, $resultp) = @_;

    # Must be a real reference. 
    return -1
	if (! ref($self));

    my $query_result;
    my @instances = ();
    my $guid = $self->guid();
    my $vers = $self->vers();

    if ($all) {
	$query_result = 
	    DBQueryWarn("select idx from experiment_template_instances ".
			"where parent_guid='$guid' and ".
			"      parent_vers='$vers'");
    }
    else {
	$query_result =
	    DBQueryWarn("select i.idx ".
			"  from experiment_template_instances as i ".
			"left join experiments as e on e.idx=i.exptidx ".
			"where i.parent_guid='$guid' and ".
			"      i.parent_vers='$vers' and e.idx is not null");
    }
    return -1
	if (!$query_result);
1221
    
1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237
    if (!$query_result->numrows) {
	@$resultp = ();
	return 0;
    }
	
    while (my ($idx) = $query_result->fetchrow_array()) {
	my $instance = Template::Instance->LookupByID($idx);
	return -1
	    if (!defined($instance));
	push(@instances, $instance);
    }

    @$resultp = @instances;
    return 0;
}

1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251
#
# Copy the datastore from parent template to child template.
#
sub CopyDataStore($$$)
{
    my ($self, $parent) = @_;

    # Must be a real reference. 
    return -1
	if (! (ref($self) && ref($parent)));

    my $from_path = $parent->path();
    my $to_path   = $self->path();

Leigh B. Stoller's avatar
Leigh B. Stoller committed
1252 1253
    Template::mysystem("cd $from_path; ".
		       "   $RSYNC -rtgoDlz datastore $to_path") == 0
1254 1255 1256 1257 1258
	or return -1;

    return 0;
}

1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322
#
# Hide Template, optionally hiding all children.
#
sub Hide($$)
{
    my ($self, $recursive) = @_;

    # Must be a real reference. 
    return -1
	if (! ref($self));

    my $guid = $self->guid();
    my $vers = $self->vers();
    
    DBQueryWarn("update experiment_templates set hidden=1 ".
		"where guid='$guid' and ".
		"      vers='$vers'")
	or return -1;
    
    Refresh($self) == 0
	or return -1;

    if ($recursive) {
	$self->Recurse("hidden=1") == 0
	    or return -1;
    }
    # This can fail; it is not critical.
    Template::mysystem("$makegraph $guid");
    
    return 0;
}

#
# Show Template, optionally showing all children.
#
sub Show($$)
{
    my ($self, $recursive) = @_;

    # Must be a real reference. 
    return -1
	if (! ref($self));

    my $guid = $self->guid();
    my $vers = $self->vers();
    
    DBQueryWarn("update experiment_templates set hidden=0 ".
		"where guid='$guid' and ".
		"      vers='$vers'")
	or return -1;
    
    Refresh($self) == 0
	or return -1;

    if ($recursive) {
	$self->Recurse("hidden=0") == 0
	    or return -1;
    }
    # This can fail; it is not critical.
    Template::mysystem("$makegraph $guid");
    
    return 0;
}

Leigh B. Stoller's avatar
Leigh B. Stoller committed
1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370
#
# Activate/InActivate a template. What is an active template? Its one the
# user is futzing with and wants at the top of the list. Inactive templates
# are there but not considered important.
#
sub Activate($)
{
    my ($self) = @_;

    # Must be a real reference. 
    return -1
	if (! ref($self));

    my $guid = $self->guid();
    my $vers = $self->vers();
    
    DBQueryWarn("update experiment_templates set active=1 ".
		"where guid='$guid' and ".
		"      vers='$vers'")
	or return -1;
    
    Refresh($self) == 0
	or return -1;

    return 0;
}
sub InActivate($)
{
    my ($self) = @_;

    # Must be a real reference. 
    return -1
	if (! ref($self));

    my $guid = $self->guid();
    my $vers = $self->vers();
    
    DBQueryWarn("update experiment_templates set active=0 ".
		"where guid='$guid' and ".
		"      vers='$vers'")
	or return -1;
    
    Refresh($self) == 0
	or return -1;

    return 0;
}

1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400
# Improve this at some point.
sub Recurse($$)
{
    my ($self, $string) = @_;
    my %children = ();

    # Must be a real reference. 
    return -1
	if (! ref($self));

    my $template_guid = $self->guid();
    my $template_vers = $self->vers();
    
    my $query_result =
	DBQueryWarn("select vers,parent_vers from experiment_templates ".
		    "where guid='$template_guid' ".
		    "order by vers");
    return -1
	if (!$query_result);

    # Build up lists of childen.
    while (my ($vers,$parent_vers) = $query_result->fetchrow_array()) {
	next
	    if (!defined($parent_vers));

	$children{$parent_vers} = []
	    if (!exists($children{$parent_vers}));
	push(@{ $children{$parent_vers} }, $vers);
    }

Leigh B. Stoller's avatar
Leigh B. Stoller committed
1401 1402 1403 1404
    # A leaf node ...
    return 0
	if (!exists($children{$template_vers}));

1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420
    # Recurse through all the children of this template.
    my @kids = @{ $children{$template_vers} };

    while (@kids) {
	my $kid     = shift(@kids);

	DBQueryWarn("update experiment_templates set $string ".
		    "where guid='$template_guid' and vers='$kid'")
	    or return -1;

	push(@kids, @{ $children{$kid} })
	    if (exists($children{$kid}));
    }
    return 0;
}

1421 1422 1423 1424 1425 1426 1427
############################################################################

package Template::Instance;
use libdb;
use libtestbed;
use libtblog;
use English;
1428
use libArchive;
1429 1430 1431 1432 1433 1434 1435 1436 1437
use overload ('""' => 'Stringify');

#
# Lookup a template experiment and create a class instance to return.
#
sub LookupByID($$)
{
    my ($class, $idx) = @_;

1438
    my $query_result =
1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455
	DBQueryWarn("select * ".
		    "  from experiment_template_instances ".
		    "where idx='$idx'");

    return undef
	if (!$query_result || !$query_result->numrows);

    my $self            = {};
    $self->{'DB'}       = $query_result->fetchrow_hashref();

    # Backlink to the template.
    my $template_guid   = $self->{'DB'}->{'parent_guid'};
    my $template_vers   = $self->{'DB'}->{'parent_vers'};
    my $template        = Template->Lookup($template_guid, $template_vers);
    return undef
	if (!defined($template));
    $self->{'TEMPLATE'} = $template;
1456

1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518
    bless($self, $class);
    return $self;
}
sub LookupByExptidx($$)
{
    my ($class, $exptidx) = @_;

    my $query_result =
	DBQueryWarn("select * ".
		    "  from experiment_template_instances ".
		    "where exptidx='$exptidx'");

    return undef
	if (!$query_result || !$query_result->numrows);

    my $self            = {};
    $self->{'DB'}       = $query_result->fetchrow_hashref();

    # Backlink to the template.
    my $template_guid   = $self->{'DB'}->{'parent_guid'};
    my $template_vers   = $self->{'DB'}->{'parent_vers'};
    my $template        = Template->Lookup($template_guid, $template_vers);
    return undef
	if (!defined($template));
    $self->{'TEMPLATE'} = $template;
    
    bless($self, $class);
    return $self;
}

#
# Create a new template instance record. This installs the new record
# in the DB, and returns a class instance. 
#
sub Create($$)
{
    my ($class, $argref) = @_;

    return undef
	if (ref($class));

    my $query = "insert into experiment_template_instances set ".
	join(",", map("$_='" . $argref->{$_} . "'", keys(%{$argref})));

    my $query_result = DBQueryWarn($query);
    return undef
	if (! $query_result);

    # Grab the insert record.
    my $idx = $query_result->insertid;

    return Template::Instance->LookupByID($idx);
}
# accessors
sub idx($)     { return ((!ref($_[0])) ? -1 : $_[0]->{'DB'}->{'idx'}); }
sub exptidx($) { return ((!ref($_[0])) ? -1 : $_[0]->{'DB'}->{'exptidx'}); }
sub guid($)    { return ((!ref($_[0])) ? -1 : $_[0]->{'DB'}->{'parent_guid'});}
sub vers($)    { return ((!ref($_[0])) ? -1 : $_[0]->{'DB'}->{'parent_vers'});}
sub pid($)     { return ((!ref($_[0])) ? -1 : $_[0]->{'DB'}->{'pid'}); }
sub eid($)     { return ((!ref($_[0])) ? -1 : $_[0]->{'DB'}->{'eid'}); }
sub uid($)     { return ((!ref($_[0])) ? -1 : $_[0]->{'DB'}->{'uid'}); }
sub runidx($)  { return ((!ref($_[0])) ? -1 : $_[0]->{'DB'}->{'runidx'}); }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
1519 1520
sub start_time { return ((!ref($_[0])) ? -1 : $_[0]->{'DB'}->{'start_time'}); }
sub stop_time  { return ((!ref($_[0])) ? -1 : $_[0]->{'DB'}->{'stop_time'}); }
1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602
sub template($){ return ((!ref($_[0])) ? -1 : $_[0]->{'TEMPLATE'}); }

#
# Stringify for output.
#
sub Stringify($)
{
    my ($self)  = @_;
    my $guid    = $self->guid();
    my $vers    = $self->vers();
    my $idx     = $self->idx();
    my $exptidx = $self->exptidx();
    my $eid     = $self->eid();

    return "[Instance:$idx exptidx:$exptidx Template:$guid/$vers]";
}

#
# Refresh instance by reloading from the DB.
#
sub Refresh($)
{
    my ($self) = @_;

    return -1
	if (! ref($self));

    my $idx = $self->idx();
    
    my $query_result =
	DBQueryWarn("select * from experiment_template_instances ".
		    "where idx='$idx'");

    return -1
	if (!$query_result || !$query_result->numrows);
	
    $self->{'DB'} = $query_result->fetchrow_hashref();
    return 0;
}

#
# Update an instance record.
#
sub Update($$;$)
{
    my ($self, $start_time, $argref) = @_;

    # Must be a real reference. 
    return -1
	if (! ref($self));

    my $idx   = $self->idx();
    my $query = "update experiment_template_instances set ";

    $query .= "start_time=now() "
	if ($start_time);

    if (defined($argref) && scalar(keys%{$argref})) {
	$query .= ","
	    if ($start_time);
	
	$query .= join(",",
		       map("$_='" . $argref->{$_} . "'", keys(%{$argref})));
    }
    $query .= " where idx='$idx'";

    return -1
	if (! DBQueryWarn($query));

    return Refresh($self);
}
# Set the start time ...
sub Start($)
{
    my ($self) = @_;

    # Must be a real reference. 
    return -1
	if (! ref($self));

    return $self->Update(1);
}
1603 1604
# Set the stop time ...
sub Stop($;$)
1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619
{
    my ($self, $argref) = @_;

    # Must be a real reference. 
    return -1
	if (! ref($self));

    my $idx = $self->idx();
    
    #
    # Do the Run record first
    #
    my $runidx = $self->runidx();

    return -1
1620
	if (defined($runidx) && StopCurrentRun($self) < 0);
1621 1622

    # And then the instance.
1623 1624 1625 1626 1627 1628
    DBQueryWarn("update experiment_template_instances set stop_time=now() ".
		"where idx='$idx'")
	or return -1;
    
    return Refresh($self);
}
1629

1630 1631 1632 1633 1634 1635
#
# Finalize.
#
sub Finalize($;$)
{
    my ($self, $argref) = @_;
1636

1637
    # Must be a real reference. 
1638
    return -1
1639 1640 1641
	if (! ref($self));

    my $idx = $self->idx();
1642
    
1643 1644 1645 1646 1647 1648 1649 1650
    #
    # Do the Run record first
    #
    my $runidx = $self->runidx();

    return -1
	if (defined($runidx) && FinalizeCurrentRun($self) < 0);

1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671
    return Refresh($self);
}

#
# Is an instance currently instantiated (a current experiment).
#
sub Instantiated($)
{
    my ($self) = @_;

    # Must be a real reference. 
    return -1
	if (! ref($self));

    my $exptidx = $self->exptidx();

    my $query_result =
	DBQueryWarn("select pid,eid from experiments where idx='$exptidx'");

    return -1
	if (! $query_result);
1672 1673

    return $query_result->numrows;
1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753
}    

#
# Delete a template instance record.
#
sub Delete($$$)
{
    my ($self) = @_;

    # Must be a real reference. 
    return -1
	if (! ref($self));

    my $guid    = $self->guid();
    my $vers    = $self->vers();
    my $idx     = $self->idx();
    my $exptidx = $self->exptidx();

    #
    # Delete the run records first since they will not mean much after
    # this record is gone.
    #
    DBQueryWarn("delete from experiment_run_bindings ".
		"where exptidx='$exptidx'")
	or return -1;

    DBQueryWarn("delete from experiment_runs ".
		"where exptidx='$exptidx'")
	or return -1;

    #
    # Also delete the binding records for the instance.
    #
    DeleteBindings($self) == 0
	or return -1;

    # And finally the instance record.
    DBQueryWarn("delete from experiment_template_instances ".
		"where idx='$idx'")
	or return -1;

    $self->{'DB'} = undef;
    return 0;
}

#
# Binding records are part of an instance, and we do not actually mess
# with them after we create them. Just need to be able to delete them,
# as when we have a failure.
#
sub NewBinding($$)
{
    my ($self, $name, $value) = @_;

    # Must be a real reference. 
    return -1
	if (! ref($self));

    my $parent_guid  = $self->guid();
    my $parent_vers  = $self->vers();
    my $pid          = $self->pid();
    my $eid          = $self->eid();
    my $instance_idx = $self->idx();