Template.pm.in 89.7 KB
Newer Older
1 2 3
#!/usr/bin/perl -wT
#
# EMULAB-COPYRIGHT
4
# Copyright (c) 2005, 2006, 2007 University of Utah and the Flux Group.
5 6 7 8
# 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 25
use Archive;
use Project;
26
use User;
27
use Experiment;
28
use Group;
29
use English;
30
use HTML::Entities;
31
use overload ('""' => 'Stringify');
32 33 34

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

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

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

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 86 87
#
# 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
88 89 90 91 92 93 94 95 96 97
# Little helper and debug function.
sub mysystem($)
{
    my ($command) = @_;

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

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

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

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

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

#
152
# Lookup a template given an experiment index.
153
#
154
sub LookupByExptidx($$)
155
{
156
    my ($class, $exptidx) = @_;
157

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

161 162
    return undef
	if (!defined($template_instance));
163

164
    return $template_instance->template();
165 166
}

167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186
#
# 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
187
#
188
# Refresh a template instance by reloading from the DB.
Leigh B. Stoller's avatar
Leigh B. Stoller committed
189
#
190
sub Refresh($)
Leigh B. Stoller's avatar
Leigh B. Stoller committed
191
{
192
    my ($self) = @_;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
193

194 195
    return -1
	if (! ref($self));
Leigh B. Stoller's avatar
Leigh B. Stoller committed
196

197 198 199 200 201 202
    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
203 204

    return -1
205 206 207
	if (!$query_result || !$query_result->numrows);
	
    $self->{'TEMPLATE'} = $query_result->fetchrow_hashref();
Leigh B. Stoller's avatar
Leigh B. Stoller committed
208 209 210
    return 0;
}

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

220 221
    return undef
	if (ref($class));
222

Leigh B. Stoller's avatar
Leigh B. Stoller committed
223 224 225 226 227 228 229 230 231
    my $pid = $argref->{'pid'};
    my $gid = $argref->{'gid'};
    # Need the group object since we want to use its idx.
    my $group = Group->LookupByPidGid($pid, $gid);
    if (!defined($group)) {
	tberror("Could not map $pid/$gid to its object!");
	return undef;
    }

232 233 234 235 236 237 238 239 240 241 242 243 244
    # 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;
245 246
    }

247 248 249
    DBQueryWarn("lock tables experiments write, ".
		"            experiment_templates write")
	or return undef;
250

251 252 253 254 255 256 257
    #
    # 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'");
258

259 260 261 262
	if (!$query_result) {
	    DBQueryWarn("unlock tables");
	    return undef;
	}
263

264 265 266
	$vers = ($query_result->fetchrow_array())[0];
	$vers++;
    }
267

268 269 270
    # 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}";
271 272 273

    $argref->{'pid_idx'} = $group->pid_idx();
    $argref->{'gid_idx'} = $group->gid_idx();
274

275
    #
276
    # Sanity check; make sure this eid is not in use. Tables are still locked.
277 278
    #
    my $query_result =
279 280
	DBQueryWarn("select pid,eid from experiments ".
		    "where eid='$eid' and pid='$pid'");
281

282 283 284 285 286 287 288 289 290
    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;
291 292
    }

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

296 297
    # Append the rest
    $query .= ",created=now(),guid='$guid',vers='$vers',eid='$eid'";
298

299 300 301 302 303 304 305
    if (! DBQueryWarn($query)) {
	DBQueryWarn("unlock tables");
	return undef;
    }
    DBQueryWarn("unlock tables");

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

#
309
# Stringify for output.
310
#
311
sub Stringify($)
312
{
313 314 315
    my ($self) = @_;
    my $guid   = $self->guid();
    my $vers   = $self->vers();
316

317
    return "[Template: $guid/$vers]";
318 319
}

320
#
321
# Update a template record given an array reference of slot/value pairs.
322
#
323
sub Update($$)
324
{
325
    my ($self, $argref) = @_;
326

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

331 332
    my $guid = $self->guid();
    my $vers = $self->vers();
333

334 335 336 337
    my $query = "update experiment_templates set ".
	join(",", map("$_='" . $argref->{$_} . "'", keys(%{$argref})));

    $query .= " where guid='$guid' and vers='$vers'";
338 339 340

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

    return Refresh($self);
343 344
}

345
#
346 347
# Delete a template (all tables). Note that other parts of the template
# like instances must already be gone when this is called.
348
#
349
sub Delete($)
350
{
351
    my ($self) = @_;
352

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

357 358
    my $guid = $self->guid();
    my $vers = $self->vers();
359 360 361 362 363 364
    my $path = $self->path();

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

366
    DeleteAllMetadata($self) == 0
367
	or return -1;
368

369 370
    DeleteInputFiles($self) == 0
	or return -1;
371

372 373 374 375
    # 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'");
376 377 378
    return -1
	if (! $query_result);

379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402
    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;
403 404 405
    return 0;
}

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

423
    if (ref($self)) {
424
	($user, $access_type) = @_;
425 426
    }
    else {
427
	($guid, $user, $access_type) = @_;
428

429 430 431 432 433 434 435 436 437
	$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!");
    }
438

439 440 441
    #
    # Admins do whatever they want!
    #
442
    if (TBAdmin()) {
443 444
	return 1;
    }
445

446 447 448 449 450 451 452 453 454 455
    #
    # Transition to using user objects instead of uids
    #
    if (! ref($user)) {
	my $uid = MapNumericUID($user);

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

457
    #
458
    # A template may be destroyed by the creator or the project/group leader.
459 460 461 462 463 464 465 466
    #
    if ($access_type == TB_EXPT_READINFO) {
	$mintrust = PROJMEMBERTRUST_USER;
    }
    else {
	$mintrust = PROJMEMBERTRUST_LOCALROOT;
    }

467 468 469 470 471 472 473
    #
    # Map to group object.
    #
    my $group = Group->Lookup($self->gid_idx());
    return 0
	if (!defined($group));

474 475 476 477 478
    #
    # 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.
    #
479 480 481 482 483 484 485 486 487 488 489 490 491 492 493
    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;
494 495
}

496
#
497
# Return a list of all children of the given template.
498
#
499
sub Children($$)
500
{
501
    my ($self, $resultp) = @_;
502

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

507 508 509 510 511 512 513 514 515 516
    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");
517
    return -1
518
	if (!$query_result);
519

520 521 522
    while (my ($vers, $parent_vers) = $query_result->fetchrow_array()) {
	$children{$parent_vers} = []
	    if (!exists($children{$parent_vers}));
523

524 525 526 527 528 529 530 531 532 533 534 535 536 537
	# 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);
538

539 540 541 542 543 544
	# New children of kid
	unshift(@allkids, @{ $children{$kid} })
	    if (exists($children{$kid}));
    }
    # Most recent templates first.
    @kids = sort {$b <=> $a} @kids;
545

546 547 548 549 550 551 552
    # Now convert to template objects.
    foreach my $vers (@kids) {
	my $template = Template->Lookup($guid, $vers);
	return -1
	    if (! $template);
	push(@result, $template);
    }
553

554
    @$resultp = @result;
555 556 557 558
    return 0;
}

#
559 560 561 562 563
# 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($$)
564
{
565 566
    my ($self, $inputfile) = @_;
    my $input_data_idx;
567

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

572
    my $data_string = `cat $inputfile`;
573 574 575
    return -1
	if ($?);

576 577 578 579
    my $guid = $self->guid();
    my $vers = $self->vers();
    my $pid  = $self->pid();
    my $tid  = $self->tid();
580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595

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

596 597 598 599
	DBQueryWarn("lock tables experiment_template_inputs write, ".
		    "            experiment_template_input_data write")
	    or return -1;

600 601 602 603
	my $query_result =
	    DBQueryWarn("select idx from experiment_template_input_data ".
			"where md5='$md5'");

604 605 606 607
	if (!$query_result) {
	    DBQueryWarn("unlock tables");
	    return -1;
	}
608 609

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

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

638
#
639
# Delete all input files, say for a template create/modify that fails.
640
#
641
sub DeleteInputFiles($)
642
{
643
    my ($self) = @_;
644

645 646 647 648 649 650 651
    # Must be a real reference. 
    return -1
	if (! ref($self));

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

    return 0;
}

692
#
693
# Add a metadata record. 
694
#
695
sub NewMetadata($$$$;$)
696
{
697
    my ($self, $name, $value, $creator, $type) = @_;
698
    my $guid;
699 700
    my $version  = 1;
    my $internal = 0;
701
    my $metadata_type;
702

703
    # Must be a real reference. 
704
    return -1
705 706 707 708
	if (! ref($self));

    my $template_guid = $self->guid();
    my $template_vers = $self->vers();
709 710
    my $creator_uid   = $creator->uid();
    my $creator_dbid  = $creator->uid_idx();
711 712 713 714 715 716

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

    # Special ...
    $internal = 1
717
	if (defined($type));
718

719
    # Current set of allowed types;
720
    my @okay_types = ("tid", "template_description", "parameter_description",
721
		      "annotation", "instance_description", "run_description");
722 723 724 725 726 727 728 729 730 731 732 733 734

    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);
735 736
    # HTML entity encode; yep, plain text only.
    my $safevalue = DBQuoteSpecial(encode_entities($value));
737 738 739

    my $query_result =
	DBQueryWarn("insert into experiment_template_metadata_items set ".
740 741
		    "   guid='$guid', vers='$version', ".
		    "   uid='$creator_uid', uid_idx='$creator_dbid', ".
742
		    "   template_guid='$template_guid', ".
743
		    "   name=$safename, value=$safevalue, created=now()");
744 745 746 747 748
    return -1
	if (!$query_result);

    DBQueryWarn("insert into experiment_template_metadata set ".
		"   parent_guid='$template_guid', ".
749
		"   parent_vers='$template_vers', ".
750 751
		"   metadata_guid='$guid', ".
		"   metadata_vers='$version', ".
752
		"   metadata_type=$metadata_type, ".
753
		"   internal=$internal")
754
	or return -1;
755 756 757 758

    # Some metadata is special ...
    if (defined($type)) {
	if ($type eq "parameter_description") {
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
	    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;
785 786
	}
    }
787 788 789 790
    
    return 0;
}

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

    # 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 =
808
	DBQueryWarn("select metadata_guid,metadata_vers,metadata_type ".
809 810 811 812 813 814 815 816 817 818 819 820
		    "   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);

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

859 860
    my $safename  = DBQuoteSpecial($name);
    my $safevalue = DBQuoteSpecial(encode_entities($value));
861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880

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

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

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

985 986
    if (defined($description) && $description ne "") {
	$self->NewMetadata($name,
987
			   $description, $user, "parameter_description")
988 989 990
	    == 0 or return -1;
    }

991 992 993
    return 0;
}

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 1019 1020 1021 1022 1023
#
# 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;
}

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 1053 1054 1055 1056 1057
#
# 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;
}

1058
#
1059
# Delete (all) template metadata
1060
#
1061
sub DeleteAllMetadata($)
1062
{
1063 1064 1065 1066 1067 1068 1069 1070
    my ($self) = @_;

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

    my $template_guid = $self->guid();
    my $template_vers = $self->vers();
1071 1072 1073 1074 1075

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

    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 ".
1110
		"      parent_vers='$template_vers'")
1111 1112 1113 1114 1115
	or return -1;

    return 0;
}

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 1153 1154 1155 1156 1157
#
# 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;
}

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

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

1170 1171 1172
    my $from_guid = $parent->guid();
    my $from_vers = $parent->vers();
    my $to_vers   = $self->vers();
1173 1174
    my $copier_uid  = $copier->uid();
    my $copier_dbid = $copier->uid_idx();
1175 1176 1177 1178 1179

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

1189
    while (my ($name,$value,$type,$internal,$hasparent) =
1190 1191
	   $query_result->fetchrow_array()) {

1192 1193
	my $guid;
	my $version = 1;
1194
	my $metadata_type = "NULL";
1195 1196
	my $parent_guid;
	my $parent_vers;
1197 1198 1199 1200
	
	$name   = DBQuoteSpecial($name);
	$value  = DBQuoteSpecial($value);

1201 1202 1203 1204
	#
	# XXX Some metadata is special ...
	#
	if (defined($type)) {
1205
	    # XXX Skip the tid and template descriptions and annotations.
1206
	    next
1207 1208 1209
		if ($type eq "tid" ||
		    $type eq "template_description" ||
		    $type eq "annotation");
1210

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

		return -1
		    if (!$param_result);
		
		next
		    if (!$param_result->numrows);
1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251

		#
		# 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;
		}
1252 1253 1254 1255
	    }
	    $metadata_type = "'$type'";
	}

1256
	return -1
1257
	    if (!defined($guid) && NewGUID(\$guid) < 0);
1258 1259 1260

	DBQueryWarn("insert into experiment_template_metadata set ".
		    "   parent_guid='$from_guid', ".
1261
		    "   parent_vers='$to_vers', ".
1262 1263
		    "   metadata_guid='$guid', ".
		    "   metadata_vers='$version', ".
1264 1265
		    "   metadata_type=$metadata_type, ".
		    "   internal=$internal")
1266 1267 1268
	    or return -1;

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

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

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 1336 1337 1338 1339 1340
#
# 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;
}

1341
#
1342
# Create a new Instance record, using the package below.
1343
#
1344
sub NewInstance($$$;$)
1345
{
1346
    my ($self, $eid, $creator, $description) = @_;
1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357

    # 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;
1358 1359
    $args{'uid'}         = $creator->uid();
    $args{'uid_idx'}     = $creator->uid_idx();
1360

1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374
    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;
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
#
# 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;
}

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 1430 1431 1432 1433 1434
#<