Template.pm.in 84.2 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
# 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

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;
23
use libArchive;
24
use User;
25
use Experiment;
26
use Group;
27
use English;
28
use HTML::Entities;
29
use overload ('""' => 'Stringify');
30 31 32

# Configure variables
my $TB		= "@prefix@";
33
my $CONTROL	= "@USERNODE@";
34
my $STAMPS      = @STAMPS@;
35
my $MD5         = "/sbin/md5";
36 37 38
my $MKDIR       = "/bin/mkdir";
my $RMDIR       = "/bin/rmdir";
my $RM		= "/bin/rm";
39
my $makegraph   = "$TB/bin/template_graph";
40
my $TEVC	= "$TB/bin/tevc";
41
my $DBCONTROL   = "$TB/sbin/opsdb_control";
42
my $RSYNC	= "/usr/local/bin/rsync";
43

44 45
# Cache of template instances to avoid regenerating them.
my %templates   = ();
46
my $debug	= 1;
47

48 49 50 51
# Flags for functions below.
sub STARTRUN_FLAGS_FIRSTRUN()	{ 0x1 ;}
sub STARTRUN_FLAGS_SWAPMOD()	{ 0x2 ;}

52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85
#
# 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
86 87 88 89 90 91 92 93 94 95
# Little helper and debug function.
sub mysystem($)
{
    my ($command) = @_;

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

96
#
97
# Lookup a template and create a class instance to return.
98
#
99
sub Lookup($$$)
100
{
101
    my ($class, $guid, $vers) = @_;
102

103 104 105 106
    # Look in cache first
    return $templates{"$guid/$vers"}
        if (exists($templates{"$guid/$vers"}));
    
107
    my $query_result =
108 109
	DBQueryWarn("select * from experiment_templates ".
		    "where guid='$guid' and vers='$vers'");
110

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

114 115 116 117 118
    my $self             = {};
    $self->{'TEMPLATE'}  = $query_result->fetchrow_hashref();
    # Filled lazily.
    $self->{'INSTANCES'} = undef;
    bless($self, $class);
119
    
120 121 122 123
    # Add to cache. 
    $templates{"$guid/$vers"} = $self;
    
    return $self;
124
}
125 126 127 128 129 130 131
# 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'}); }
132
sub path($) { return ((! ref($_[0])) ? -1 : $_[0]->{'TEMPLATE'}->{'path'}); }
133 134
sub archive_idx($) {
    return ((! ref($_[0])) ? -1 : $_[0]->{'TEMPLATE'}->{'archive_idx'}); }
135 136 137 138
sub parent_guid($) {
    return ((! ref($_[0])) ? -1 : $_[0]->{'TEMPLATE'}->{'parent_guid'}); }
sub IsRoot($) {
    return ! defined($_[0]->{'TEMPLATE'}->{'parent_guid'}); }
139 140 141 142 143 144
sub child_guid($) {
    return ((! ref($_[0])) ? -1 : $_[0]->{'TEMPLATE'}->{'child_guid'}); }
sub child_vers($) {
    return ((! ref($_[0])) ? -1 : $_[0]->{'TEMPLATE'}->{'child_vers'}); }
sub description($) {
    return ((! ref($_[0])) ? -1 : $_[0]->{'TEMPLATE'}->{'description'}); }
145 146

#
147
# Lookup a template given an experiment index.
148
#
149
sub LookupByExptidx($$)
150
{
151
    my ($class, $exptidx) = @_;
152

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

156 157
    return undef
	if (!defined($template_instance));
158

159
    return $template_instance->template();
160 161
}

162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181
#
# Lookup a template given pid,eid. This refers to the template itself,
# not an instance of the template.
#
sub LookupByPidEid($$$)
{
    my ($class, $pid, $eid) = @_;

    my $query_result =
	DBQueryWarn("select guid,vers from experiment_templates ".
		    "where pid='$pid' and eid='$eid'");

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

    my ($guid,$vers) = $query_result->fetchrow_array();

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

Leigh B. Stoller's avatar
Leigh B. Stoller committed
182
#
183
# Refresh a template instance by reloading from the DB.
Leigh B. Stoller's avatar
Leigh B. Stoller committed
184
#
185
sub Refresh($)
Leigh B. Stoller's avatar
Leigh B. Stoller committed
186
{
187
    my ($self) = @_;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
188

189 190
    return -1
	if (! ref($self));
Leigh B. Stoller's avatar
Leigh B. Stoller committed
191

192 193 194 195 196 197
    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
198 199

    return -1
200 201 202
	if (!$query_result || !$query_result->numrows);
	
    $self->{'TEMPLATE'} = $query_result->fetchrow_hashref();
Leigh B. Stoller's avatar
Leigh B. Stoller committed
203 204 205
    return 0;
}

206
#
207 208
# Create a new template. This installs the new record in the DB,
# and returns an instance. There is some bookkeeping along the way.
209
#
210
sub Create($$)
211
{
212 213
    my ($class, $argref) = @_;
    my ($guid, $vers);
214

215 216
    return undef
	if (ref($class));
217

218 219 220 221 222 223 224 225 226 227 228 229 230
    # 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;
231 232
    }

233 234 235
    DBQueryWarn("lock tables experiments write, ".
		"            experiment_templates write")
	or return undef;
236

237 238 239 240 241 242 243
    #
    # 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'");
244

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

250 251 252
	$vers = ($query_result->fetchrow_array())[0];
	$vers++;
    }
253

254 255 256 257
    # 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'};
258 259 260 261 262 263 264 265 266 267 268
    my $gid = $argref->{'gid'};

    # Need the group object since we want to use its idx.
    my $group = Group->LookupByPidGid($pid, $gid);
    if (!defined($group)) {
	DBQueryWarn("unlock tables");
	tberror("Could not map $pid/$gid to its object!");
	return undef;
    }
    $argref->{'pid_idx'} = $group->pid_idx();
    $argref->{'gid_idx'} = $group->gid_idx();
269

270
    #
271
    # Sanity check; make sure this eid is not in use. Tables are still locked.
272 273
    #
    my $query_result =
274 275
	DBQueryWarn("select pid,eid from experiments ".
		    "where eid='$eid' and pid='$pid'");
276

277 278 279 280 281 282 283 284 285
    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;
286 287
    }

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

291 292
    # Append the rest
    $query .= ",created=now(),guid='$guid',vers='$vers',eid='$eid'";
293

294 295 296 297 298 299 300
    if (! DBQueryWarn($query)) {
	DBQueryWarn("unlock tables");
	return undef;
    }
    DBQueryWarn("unlock tables");

    return Template->Lookup($guid, $vers);
301 302 303
}

#
304
# Stringify for output.
305
#
306
sub Stringify($)
307
{
308 309 310
    my ($self) = @_;
    my $guid   = $self->guid();
    my $vers   = $self->vers();
311

312
    return "[Template: $guid/$vers]";
313 314
}

315
#
316
# Update a template record given an array reference of slot/value pairs.
317
#
318
sub Update($$)
319
{
320
    my ($self, $argref) = @_;
321

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

326 327
    my $guid = $self->guid();
    my $vers = $self->vers();
328

329 330 331 332
    my $query = "update experiment_templates set ".
	join(",", map("$_='" . $argref->{$_} . "'", keys(%{$argref})));

    $query .= " where guid='$guid' and vers='$vers'";
333 334 335

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

    return Refresh($self);
338 339
}

340
#
341 342
# Delete a template (all tables). Note that other parts of the template
# like instances must already be gone when this is called.
343
#
344
sub Delete($)
345
{
346
    my ($self) = @_;
347

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

352 353
    my $guid = $self->guid();
    my $vers = $self->vers();
354 355 356 357 358 359
    my $path = $self->path();

    if (defined($path) && $path ne "" && -e $path) {
	mysystem("$RM -rf $path") == 0
	    or return -1;
    }
360

361
    DeleteAllMetadata($self) == 0
362
	or return -1;
363

364 365
    DeleteInputFiles($self) == 0
	or return -1;
366

367 368 369 370
    # 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'");
371 372 373
    return -1
	if (! $query_result);

374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397
    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;
398 399 400
    return 0;
}

401
#
402
# Template permission checks. Using the experiment access check stuff.
403
#
404 405 406
# Usage: AccessCheck($guid, $uid, $access_type)
#	 returns 0 if not allowed.
#        returns 1 if allowed.
407
#
408
sub AccessCheck($$$;$)
409
{
410
    my ($self, $guid, $user, $access_type);
411 412 413 414 415 416
    my $mintrust;
    
    #
    # If called as a method, no guid argument is provided. 
    #
    $self = shift();
417

418
    if (ref($self)) {
419
	($user, $access_type) = @_;
420 421
    }
    else {
422
	($guid, $user, $access_type) = @_;
423

424 425 426 427 428 429 430 431 432
	$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!");
    }
433

434 435 436
    #
    # Admins do whatever they want!
    #
437
    if (TBAdmin()) {
438 439
	return 1;
    }
440

441 442 443 444 445 446 447 448 449 450
    #
    # Transition to using user objects instead of uids
    #
    if (! ref($user)) {
	my $uid = MapNumericUID($user);

	$user = User->Lookup($uid);
	return 0
	    if (! defined($user));
    }
451

452
    #
453
    # A template may be destroyed by the creator or the project/group leader.
454 455 456 457 458 459 460 461
    #
    if ($access_type == TB_EXPT_READINFO) {
	$mintrust = PROJMEMBERTRUST_USER;
    }
    else {
	$mintrust = PROJMEMBERTRUST_LOCALROOT;
    }

462 463 464 465 466 467 468
    #
    # Map to group object.
    #
    my $group = Group->Lookup($self->gid_idx());
    return 0
	if (!defined($group));

469 470 471 472 473
    #
    # 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.
    #
474 475 476 477 478 479 480 481 482 483 484 485 486 487 488
    my $membership = $group->LookupUser($user);
    return 1
	if (defined($membership) &&
	    TBMinTrust($membership->trust(), $mintrust));

    my $project = $group->GetProject();
    return 0
	if (!defined($project));

    $membership = $project->LookupUser($user);
    return 1
	if (defined($membership) &&
	    TBMinTrust($membership->trust(), PROJMEMBERTRUST_GROUPROOT));

    return 0;
489 490
}

491
#
492
# Return a list of all children of the given template.
493
#
494
sub Children($$)
495
{
496
    my ($self, $resultp) = @_;
497

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

502 503 504 505 506 507 508 509 510 511
    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");
512
    return -1
513
	if (!$query_result);
514

515 516 517
    while (my ($vers, $parent_vers) = $query_result->fetchrow_array()) {
	$children{$parent_vers} = []
	    if (!exists($children{$parent_vers}));
518

519 520 521 522 523 524 525 526 527 528 529 530 531 532
	# 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);
533

534 535 536 537 538 539
	# New children of kid
	unshift(@allkids, @{ $children{$kid} })
	    if (exists($children{$kid}));
    }
    # Most recent templates first.
    @kids = sort {$b <=> $a} @kids;
540

541 542 543 544 545 546 547
    # Now convert to template objects.
    foreach my $vers (@kids) {
	my $template = Template->Lookup($guid, $vers);
	return -1
	    if (! $template);
	push(@result, $template);
    }
548

549
    @$resultp = @result;
550 551 552 553
    return 0;
}

#
554 555 556 557 558
# 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($$)
559
{
560 561
    my ($self, $inputfile) = @_;
    my $input_data_idx;
562

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

567
    my $data_string = `cat $inputfile`;
568 569 570
    return -1
	if ($?);

571 572 573 574
    my $guid = $self->guid();
    my $vers = $self->vers();
    my $pid  = $self->pid();
    my $tid  = $self->tid();
575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590

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

591 592 593 594
	DBQueryWarn("lock tables experiment_template_inputs write, ".
		    "            experiment_template_input_data write")
	    or return -1;

595 596 597 598
	my $query_result =
	    DBQueryWarn("select idx from experiment_template_input_data ".
			"where md5='$md5'");

599 600 601 602
	if (!$query_result) {
	    DBQueryWarn("unlock tables");
	    return -1;
	}
603 604

	if ($query_result->numrows) {
605
	    ($input_data_idx) = $query_result->fetchrow_array();
606 607 608 609 610 611 612
	}
	else {
	    $query_result =
		DBQueryWarn("insert into experiment_template_input_data ".
			    "(idx, md5, input) ".
			    "values (NULL, '$md5', $data_string)");
	    
613 614 615 616 617
	    if (!$query_result) {
		DBQueryWarn("unlock tables");
		return -1;
	    }
	    $input_data_idx = $query_result->insertid;
618 619
	}

620 621 622 623
	$query_result =
	    DBQueryWarn("insert into experiment_template_inputs ".
			" (idx, parent_guid, parent_vers, ".
			"  pid, tid, input_idx) values ".
624
			" (NULL, '$guid', '$vers', '$pid', '$tid', ".
625 626
			"  '$input_data_idx')");
	DBQueryWarn("unlock tables");
627
	return -1
628
	    if (!$query_result);
629 630 631 632
    }
    return 0;
}

633
#
634
# Delete all input files, say for a template create/modify that fails.
635
#
636
sub DeleteInputFiles($)
637
{
638
    my ($self) = @_;
639

640 641 642 643 644 645 646
    # Must be a real reference. 
    return -1
	if (! ref($self));

    my $guid = $self->guid();
    my $vers = $self->vers();
    
647 648
    DBQueryWarn("lock tables experiment_template_inputs as i write, ".
		"            experiment_template_inputs as j write, ".
Leigh B. Stoller's avatar
Leigh B. Stoller committed
649
		"            experiment_template_inputs write, ".
650 651 652 653 654 655 656 657 658 659 660 661 662 663
		"            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 ".
664
		    "      i.parent_vers='$vers' ".
665 666 667 668 669 670 671 672 673 674 675 676 677
		    "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 ".
678
		    "where parent_guid='$guid' and parent_vers='$vers'");
679 680 681 682 683 684 685 686
    DBQueryWarn("unlock tables");
    
    return -1
	if (! $query_result);

    return 0;
}

687
#
688
# Add a metadata record. 
689
#
690
sub NewMetadata($$$$;$)
691
{
692
    my ($self, $name, $value, $creator, $type) = @_;
693
    my $guid;
694 695
    my $version  = 1;
    my $internal = 0;
696
    my $metadata_type;
697

698
    # Must be a real reference. 
699
    return -1
700 701 702 703
	if (! ref($self));

    my $template_guid = $self->guid();
    my $template_vers = $self->vers();
704 705
    my $creator_uid   = $creator->uid();
    my $creator_dbid  = $creator->uid_idx();
706 707 708 709 710 711

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

    # Special ...
    $internal = 1
712
	if (defined($type));
713

714
    # Current set of allowed types;
715
    my @okay_types = ("tid", "template_description", "parameter_description",
716
		      "annotation", "instance_description", "run_description");
717 718 719 720 721 722 723 724 725 726 727 728 729

    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);
730 731
    # HTML entity encode; yep, plain text only.
    my $safevalue = DBQuoteSpecial(encode_entities($value));
732 733 734

    my $query_result =
	DBQueryWarn("insert into experiment_template_metadata_items set ".
735 736
		    "   guid='$guid', vers='$version', ".
		    "   uid='$creator_uid', uid_idx='$creator_dbid', ".
737
		    "   template_guid='$template_guid', ".
738
		    "   name=$safename, value=$safevalue, created=now()");
739 740 741 742 743
    return -1
	if (!$query_result);

    DBQueryWarn("insert into experiment_template_metadata set ".
		"   parent_guid='$template_guid', ".
744
		"   parent_vers='$template_vers', ".
745 746
		"   metadata_guid='$guid', ".
		"   metadata_vers='$version', ".
747
		"   metadata_type=$metadata_type, ".
748
		"   internal=$internal")
749
	or return -1;
750 751 752 753

    # Some metadata is special ...
    if (defined($type)) {
	if ($type eq "parameter_description") {
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
	    DBQueryWarn("update experiment_template_parameters set ".
			"   metadata_guid='$guid', ".
			"   metadata_vers='$version' ".
			"where parent_guid='$template_guid' and ".
			"      parent_vers='$template_vers' and ".
			"      name=$safename")
		or return -1;
 	}
	elsif ($type eq "instance_description" &&
	       $name =~ /^__instance_description_(\d*)$/) {
	    my $exptidx = $1;
	    
	    DBQueryWarn("update experiment_template_instances set ".
			"  description=$safevalue ".
			"where exptidx='$exptidx'")
		or return -1;
	}
	elsif ($type eq "run_description" &&
	       $name =~ /^__run_description_(\d*)_(\d*)$/) {
	    my $exptidx = $1;
	    my $runidx  = $2;
	    
	    DBQueryWarn("update experiment_runs set ".
			"  description=$safevalue ".
			"where exptidx='$exptidx' and idx='$runidx'")
		or return -1;
780 781
	}
    }
782 783 784 785
    
    return 0;
}

786 787 788
#
# Lookup a metadata value by name, optionally returning guid/vers.
#
789
sub LookupMetadata($$;$$$)
790
{
791
    my ($self, $name, $pguid, $pvers, $ptype) = @_;
792 793 794 795 796 797 798 799 800 801 802

    # 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 =
803
	DBQueryWarn("select metadata_guid,metadata_vers,metadata_type ".
804 805 806 807 808 809 810 811 812 813 814 815
		    "   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);

816 817
    my ($metadata_guid, $metadata_vers, $metadata_type) =
	$query_result->fetchrow_array();
818 819 820 821
    $$pguid = $metadata_guid
	if (defined($pguid));
    $$pvers = $metadata_vers
	if (defined($pvers));
822 823
    $$ptype = $metadata_type
	if (defined($ptype));
824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842
    
    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();
843 844
    my $creator_uid   = $creator->uid();
    my $creator_dbid  = $creator->uid_idx();
845 846
    my $parent_guid;
    my $parent_vers;
847
    my $metadata_type;
848
    my $already_exists =
849 850
	$self->LookupMetadata($name,
			      \$parent_guid, \$parent_vers, \$metadata_type);
851 852 853
    return -1
	if ($already_exists <= 0);

854 855
    my $safename  = DBQuoteSpecial($name);
    my $safevalue = DBQuoteSpecial(encode_entities($value));
856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875

    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', ".
876 877
		     "     template_guid='$template_guid', ".
		     "     uid='$creator_uid', uid_idx='$creator_dbid', ".
878 879
		     "     parent_guid='$parent_guid',".
		     "     parent_vers='$parent_vers'," .
880
		     "     name=$safename, value=$safevalue, created=now()")) {
881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897
	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 ...
    #
898 899
    if (defined($metadata_type)) {
	if ($metadata_type eq "tid") {
900
	    DBQueryWarn("update experiment_templates set tid=$safevalue ".
901 902 903 904 905 906
			"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
907
	    Template::mysystem("$makegraph $template_guid");
908 909
	}
	elsif ($metadata_type eq "template_description") {
910 911
	    DBQueryWarn("update experiment_templates set ".
			"   description=$safevalue ".
912 913 914 915 916 917 918 919 920 921
			"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' ".
922 923
			"where parent_guid='$template_guid' and ".
			"      parent_vers='$template_vers' and ".
924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944
			"      name=$safename")
		or return -1;
	}
	elsif ($metadata_type eq "instance_description" &&
	       $name =~ /^__instance_description_(\d*)$/) {
	    my $exptidx = $1;
	    
	    DBQueryWarn("update experiment_template_instances set ".
			"  description=$safevalue ".
			"where exptidx='$exptidx'")
		or return -1;
	}
	elsif ($metadata_type eq "run_description" &&
	       $name =~ /^__run_description_(\d*)_(\d*)$/) {
	    my $exptidx = $1;
	    my $runidx  = $2;
	    
	    DBQueryWarn("update experiment_runs set ".
			"  description=$safevalue ".
			"where exptidx='$exptidx' and idx='$runidx'")
		or return -1;
945
	}
946 947 948 949 950
    }
    return 0;
}

#
951
# Add a formal parameter to a template.
952
#
953
sub NewFormalParameter($$$$$)
954
{
955
    my ($self, $name, $value, $description, $user) = @_;
956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979

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

980 981
    if (defined($description) && $description ne "") {
	$self->NewMetadata($name,
982
			   $description, $user, "parameter_description")
983 984 985
	    == 0 or return -1;
    }

986 987 988
    return 0;
}

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

1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052
#
# 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;
}

1053
#
1054
# Delete (all) template metadata
1055
#
1056
sub DeleteAllMetadata($)
1057
{
1058 1059 1060 1061 1062 1063 1064 1065
    my ($self) = @_;

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

    my $template_guid = $self->guid();
    my $template_vers = $self->vers();
1066 1067 1068 1069 1070

    my $query_result =
	DBQueryWarn("select metadata_guid ".
		    "    from experiment_template_metadata ".
		    "where parent_guid='$template_guid' and ".
1071
		    "      parent_vers='$template_vers'");
1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104

    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 ".
1105
		"      parent_vers='$template_vers'")
1106 1107 1108 1109 1110
	or return -1;

    return 0;
}

1111 1112 1113 1114 1115 1116 1117 1118 1119 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
#
# 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;
}

1153 1154 1155 1156
#
# Copy exiting template metadata to a child. This is likely to change
# since we probably want to share at some point.
#
1157
sub CopyMetadata($$$)
1158
{
1159
    my ($self, $parent, $copier) = @_;
1160 1161 1162

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

1165 1166 1167
    my $from_guid = $parent->guid();
    my $from_vers = $parent->vers();
    my $to_vers   = $self->vers();
1168 1169
    my $copier_uid  = $copier->uid();
    my $copier_dbid = $copier->uid_idx();
1170 1171 1172 1173 1174

    #
    # Copy the toplevel items.
    #
    my $query_result =
1175
	DBQueryWarn("select name,value,metadata_type,internal,i.parent_guid ".
1176 1177 1178 1179 1180
		    "  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 ".
1181
		    "      m.parent_vers='$from_vers'")
1182 1183
	or return -1;

1184
    while (my ($name,$value,$type,$internal,$hasparent) =
1185 1186
	   $query_result->fetchrow_array()) {

1187 1188
	my $guid;
	my $version = 1;
1189
	my $metadata_type = "NULL";
1190 1191
	my $parent_guid;
	my $parent_vers;
1192 1193 1194 1195
	
	$name   = DBQuoteSpecial($name);
	$value  = DBQuoteSpecial($value);

1196 1197 1198 1199
	#
	# XXX Some metadata is special ...
	#
	if (defined($type)) {
1200
	    # XXX Skip the tid and template descriptions and annotations.
1201
	    next
1202 1203 1204
		if ($type eq "tid" ||
		    $type eq "template_description" ||
		    $type eq "annotation");
1205

1206 1207 1208 1209
	    #
	    # XXX Skip parameters that were deleted or whose description
	    # was modified after being created.
	    #
1210 1211 1212 1213
	    if ($type eq "parameter_description") {
		my $param_result = 
		    DBQueryWarn("select * ".
				"   from experiment_template_parameters ".
1214 1215 1216
				"where parent_guid='$from_guid' and ".
				"      parent_vers='$to_vers' and ".
				"      name=$name");
1217 1218 1219 1220 1221 1222

		return -1
		    if (!$param_result);
		
		next
		    if (!$param_result->numrows);
1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246

		#
		# If the current parameter has a metadata description, it
		# came from the NS file parse. If the version we are
		# copying from has no parent, it has not been modified and
		# so we do not want to take that one; use the current one
		# from the NS file instead. If on the other hand the user
		# modified that description after its NS file parse, we take
		# that since we assume its a better description. Hmm, this
		# sounds awful when described.
		#
		my $param_row = $param_result->fetchrow_hashref();

		if (defined($param_row->{"metadata_guid"})) {
		    next
			if (! $hasparent);
		    
		    $parent_guid = $param_row->{"metadata_guid"};
		    $parent_vers = $param_row->{"metadata_vers"};

		    # and of course we need to use this guid/vers.
		    $guid = $parent_guid;
		    $version = $parent_vers + 1;
		}
1247 1248 1249 1250
	    }
	    $metadata_type = "'$type'";
	}

1251
	return -1
1252
	    if (!defined($guid) && NewGUID(\$guid) < 0);
1253 1254 1255

	DBQueryWarn("insert into experiment_template_metadata set ".
		    "   parent_guid='$from_guid', ".
1256
		    "   parent_vers='$to_vers', ".
1257 1258
		    "   metadata_guid='$guid', ".
		    "   metadata_vers='$version', ".
1259 1260
		    "   metadata_type=$metadata_type, ".
		    "   internal=$internal")
1261 1262 1263
	    or return -1;

	DBQueryWarn("insert into experiment_template_metadata_items set ".
1264 1265
		    "   guid='$guid', vers='$version', ".
		    "   uid='$copier_uid', uid_idx='$copier_dbid', ".
1266
		    "   template_guid='$from_guid', ".
1267 1268 1269
		    (! defined($parent_guid) ? "" :
		     "  parent_guid='$parent_guid',".
		     "  parent_vers='$parent_vers',") .
1270 1271 1272
		    "   name=$name, value=$value, created=now()")
	    or return -1;

1273 1274 1275 1276 1277 1278 1279 1280
	#
	# 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' ".
1281 1282 1283
			    "where parent_guid='$from_guid' and ".
			    "      parent_vers='$to_vers' and ".
			    "      name=$name")
1284 1285 1286 1287
		    or return -1
		}
	}
    }
1288 1289 1290
    return 0;
}

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 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335
#
# 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;
}

1336
#
1337
# Create a new Instance record, using the package below.
1338
#
1339
sub NewInstance($$$;$)
1340
{
1341
    my ($self, $eid, $creator, $description) = @_;
1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352

    # 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;
1353 1354
    $args{'uid'}         = $creator->uid();
    $args{'uid_idx'}     = $creator->uid_idx();
1355

1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369
    my $newinstance = Template::Instance->Create(\%args);
    return undef
	if (!defined($newinstance));

    #
    # The description is versioned metadata the user can modify.
    #
    if (defined($description)) {
	my $exptidx = $newinstance->exptidx();
    
	$self->NewMetadata("__instance_description_${exptidx}", $description,
			   $creator, "instance_description");
    }
    return $newinstance;
1370 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
#
# Lookup specific instance by its exptidx. The point of this is to ensure
# that the instance is really associated with the template, since by itself,
# the exptidx is enough to find the instance record.
#
sub LookupInstance($$)
{
    my ($self, $exptidx) = @_;

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

    my $instance = Template::Instance->LookupByExptidx($exptidx);
    return undef
	if (!defined($instance));

    return undef
	if (! ($self->guid() == $instance->guid() &&
	       $self->vers() == $instance->vers()));

    return $instance;
}

1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429
#
# 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);
1430
    
1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446
    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;
}

1447 1448 1449
#
# Copy the datastore from parent template to child template.
#