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

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

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

40 41
# Cache of template instances to avoid regenerating them.
my %templates   = ();
42
my $debug	= 1;
43

44 45 46 47
# Flags for functions below.
sub STARTRUN_FLAGS_FIRSTRUN()	{ 0x1 ;}
sub STARTRUN_FLAGS_SWAPMOD()	{ 0x2 ;}

48 49 50 51 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
#
# 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
82 83 84 85 86 87 88 89 90 91
# Little helper and debug function.
sub mysystem($)
{
    my ($command) = @_;

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

92
#
93
# Lookup a template and create a class instance to return.
94
#
95
sub Lookup($$$)
96
{
97
    my ($class, $guid, $vers) = @_;
98

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

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

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

#
143
# Lookup a template given an experiment index.
144
#
145
sub LookupByExptidx($$)
146
{
147
    my ($class, $exptidx) = @_;
148

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

152 153
    return undef
	if (!defined($template_instance));
154

155
    return $template_instance->template();
156 157
}

158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177
#
# 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
178
#
179
# Refresh a template instance by reloading from the DB.
Leigh B. Stoller's avatar
Leigh B. Stoller committed
180
#
181
sub Refresh($)
Leigh B. Stoller's avatar
Leigh B. Stoller committed
182
{
183
    my ($self) = @_;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
184

185 186
    return -1
	if (! ref($self));
Leigh B. Stoller's avatar
Leigh B. Stoller committed
187

188 189 190 191 192 193
    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
194 195

    return -1
196 197 198
	if (!$query_result || !$query_result->numrows);
	
    $self->{'TEMPLATE'} = $query_result->fetchrow_hashref();
Leigh B. Stoller's avatar
Leigh B. Stoller committed
199 200 201
    return 0;
}

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

211 212
    return undef
	if (ref($class));
213

214 215 216 217 218 219 220 221 222 223 224 225 226
    # 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;
227 228
    }

229 230 231
    DBQueryWarn("lock tables experiments write, ".
		"            experiment_templates write")
	or return undef;
232

233 234 235 236 237 238 239
    #
    # 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'");
240

241 242 243 244
	if (!$query_result) {
	    DBQueryWarn("unlock tables");
	    return undef;
	}
245

246 247 248
	$vers = ($query_result->fetchrow_array())[0];
	$vers++;
    }
249

250 251 252 253
    # 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'};
254

255
    #
256
    # Sanity check; make sure this eid is not in use. Tables are still locked.
257 258
    #
    my $query_result =
259 260
	DBQueryWarn("select pid,eid from experiments ".
		    "where eid='$eid' and pid='$pid'");
261

262 263 264 265 266 267 268 269 270
    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;
271 272
    }

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

276 277
    # Append the rest
    $query .= ",created=now(),guid='$guid',vers='$vers',eid='$eid'";
278

279 280 281 282 283 284 285
    if (! DBQueryWarn($query)) {
	DBQueryWarn("unlock tables");
	return undef;
    }
    DBQueryWarn("unlock tables");

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

#
289
# Stringify for output.
290
#
291
sub Stringify($)
292
{
293 294 295
    my ($self) = @_;
    my $guid   = $self->guid();
    my $vers   = $self->vers();
296

297
    return "[Template: $guid/$vers]";
298 299
}

300
#
301
# Update a template record given an array reference of slot/value pairs.
302
#
303
sub Update($$)
304
{
305
    my ($self, $argref) = @_;
306

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

311 312
    my $guid = $self->guid();
    my $vers = $self->vers();
313

314 315 316 317
    my $query = "update experiment_templates set ".
	join(",", map("$_='" . $argref->{$_} . "'", keys(%{$argref})));

    $query .= " where guid='$guid' and vers='$vers'";
318 319 320

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

    return Refresh($self);
323 324
}

325
#
326 327
# Delete a template (all tables). Note that other parts of the template
# like instances must already be gone when this is called.
328
#
329
sub Delete($)
330
{
331
    my ($self) = @_;
332

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

337 338
    my $guid = $self->guid();
    my $vers = $self->vers();
339 340 341 342 343 344
    my $path = $self->path();

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

346
    DeleteAllMetadata($self) == 0
347
	or return -1;
348

349 350
    DeleteInputFiles($self) == 0
	or return -1;
351

352 353 354 355
    # 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'");
356 357 358
    return -1
	if (! $query_result);

359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382
    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;
383 384 385
    return 0;
}

386
#
387
# Template permission checks. Using the experiment access check stuff.
388
#
389 390 391
# Usage: AccessCheck($guid, $uid, $access_type)
#	 returns 0 if not allowed.
#        returns 1 if allowed.
392
#
393
sub AccessCheck($$$;$)
394
{
395 396 397 398 399 400 401
    my ($self, $guid, $uid, $access_type);
    my $mintrust;
    
    #
    # If called as a method, no guid argument is provided. 
    #
    $self = shift();
402

403 404 405 406 407
    if (ref($self)) {
	($uid, $access_type) = @_;
    }
    else {
	($guid, $uid, $access_type) = @_;
408

409 410 411 412 413 414 415 416 417
	$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!");
    }
418

419 420 421 422 423 424 425
    #
    # Admins do whatever they want!
    #
    if (TBAdmin($uid)) {
	return 1;
    }
    $uid = MapNumericUID($uid);
426

427 428
    my $pid = $self->pid();
    my $gid = $self->gid();
429

430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447
    #
    # 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);
448 449
}

450
#
451
# Return a list of all children of the given template.
452
#
453
sub Children($$)
454
{
455
    my ($self, $resultp) = @_;
456

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

461 462 463 464 465 466 467 468 469 470
    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");
471
    return -1
472
	if (!$query_result);
473

474 475 476
    while (my ($vers, $parent_vers) = $query_result->fetchrow_array()) {
	$children{$parent_vers} = []
	    if (!exists($children{$parent_vers}));
477

478 479 480 481 482 483 484 485 486 487 488 489 490 491
	# 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);
492

493 494 495 496 497 498
	# New children of kid
	unshift(@allkids, @{ $children{$kid} })
	    if (exists($children{$kid}));
    }
    # Most recent templates first.
    @kids = sort {$b <=> $a} @kids;
499

500 501 502 503 504 505 506
    # Now convert to template objects.
    foreach my $vers (@kids) {
	my $template = Template->Lookup($guid, $vers);
	return -1
	    if (! $template);
	push(@result, $template);
    }
507

508
    @$resultp = @result;
509 510 511 512
    return 0;
}

#
513 514 515 516 517
# 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($$)
518
{
519 520
    my ($self, $inputfile) = @_;
    my $input_data_idx;
521

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

526
    my $data_string = `cat $inputfile`;
527 528 529
    return -1
	if ($?);

530 531 532 533
    my $guid = $self->guid();
    my $vers = $self->vers();
    my $pid  = $self->pid();
    my $tid  = $self->tid();
534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549

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

550 551 552 553
	DBQueryWarn("lock tables experiment_template_inputs write, ".
		    "            experiment_template_input_data write")
	    or return -1;

554 555 556 557
	my $query_result =
	    DBQueryWarn("select idx from experiment_template_input_data ".
			"where md5='$md5'");

558 559 560 561
	if (!$query_result) {
	    DBQueryWarn("unlock tables");
	    return -1;
	}
562 563

	if ($query_result->numrows) {
564
	    ($input_data_idx) = $query_result->fetchrow_array();
565 566 567 568 569 570 571
	}
	else {
	    $query_result =
		DBQueryWarn("insert into experiment_template_input_data ".
			    "(idx, md5, input) ".
			    "values (NULL, '$md5', $data_string)");
	    
572 573 574 575 576
	    if (!$query_result) {
		DBQueryWarn("unlock tables");
		return -1;
	    }
	    $input_data_idx = $query_result->insertid;
577 578
	}

579 580 581 582
	$query_result =
	    DBQueryWarn("insert into experiment_template_inputs ".
			" (idx, parent_guid, parent_vers, ".
			"  pid, tid, input_idx) values ".
583
			" (NULL, '$guid', '$vers', '$pid', '$tid', ".
584 585
			"  '$input_data_idx')");
	DBQueryWarn("unlock tables");
586
	return -1
587
	    if (!$query_result);
588 589 590 591
    }
    return 0;
}

592
#
593
# Delete all input files, say for a template create/modify that fails.
594
#
595
sub DeleteInputFiles($)
596
{
597
    my ($self) = @_;
598

599 600 601 602 603 604 605
    # Must be a real reference. 
    return -1
	if (! ref($self));

    my $guid = $self->guid();
    my $vers = $self->vers();
    
606 607
    DBQueryWarn("lock tables experiment_template_inputs as i write, ".
		"            experiment_template_inputs as j write, ".
Leigh B. Stoller's avatar
Leigh B. Stoller committed
608
		"            experiment_template_inputs write, ".
609 610 611 612 613 614 615 616 617 618 619 620 621 622
		"            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 ".
623
		    "      i.parent_vers='$vers' ".
624 625 626 627 628 629 630 631 632 633 634 635 636
		    "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 ".
637
		    "where parent_guid='$guid' and parent_vers='$vers'");
638 639 640 641 642 643 644 645
    DBQueryWarn("unlock tables");
    
    return -1
	if (! $query_result);

    return 0;
}

646
#
647
# Add a metadata record. 
648
#
649
sub NewMetadata($$$$;$)
650
{
651
    my ($self, $name, $value, $creator, $type) = @_;
652
    my $guid;
653 654
    my $version  = 1;
    my $internal = 0;
655
    my $metadata_type;
656

657
    # Must be a real reference. 
658
    return -1
659 660 661 662 663 664 665 666 667 668
	if (! ref($self));

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

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

    # Special ...
    $internal = 1
669
	if (defined($type));
670

671 672 673 674 675 676 677 678 679 680 681 682 683 684 685
    # 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);
686 687
    # HTML entity encode; yep, plain text only.
    my $safevalue = DBQuoteSpecial(encode_entities($value));
688 689 690

    my $query_result =
	DBQueryWarn("insert into experiment_template_metadata_items set ".
691
		    "   guid='$guid', vers='$version', uid='$creator', ".
692
		    "   template_guid='$template_guid', ".
693
		    "   name=$safename, value=$safevalue, created=now()");
694 695 696 697 698
    return -1
	if (!$query_result);

    DBQueryWarn("insert into experiment_template_metadata set ".
		"   parent_guid='$template_guid', ".
699
		"   parent_vers='$template_vers', ".
700 701
		"   metadata_guid='$guid', ".
		"   metadata_vers='$version', ".
702
		"   metadata_type=$metadata_type, ".
703
		"   internal=$internal")
704
	or return -1;
705 706 707 708 709 710 711 712

    # 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' ".
713 714 715
			    "where parent_guid='$template_guid' and ".
			    "      parent_vers='$template_vers' and ".
			    "      name=$safename");
716 717 718 719
	    return -1
		if (!$query_result);
	}
    }
720 721 722 723
    
    return 0;
}

724 725 726
#
# Lookup a metadata value by name, optionally returning guid/vers.
#
727
sub LookupMetadata($$;$$$)
728
{
729
    my ($self, $name, $pguid, $pvers, $ptype) = @_;
730 731 732 733 734 735 736 737 738 739 740

    # 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 =
741
	DBQueryWarn("select metadata_guid,metadata_vers,metadata_type ".
742 743 744 745 746 747 748 749 750 751 752 753
		    "   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);

754 755
    my ($metadata_guid, $metadata_vers, $metadata_type) =
	$query_result->fetchrow_array();
756 757 758 759
    $$pguid = $metadata_guid
	if (defined($pguid));
    $$pvers = $metadata_vers
	if (defined($pvers));
760 761
    $$ptype = $metadata_type
	if (defined($ptype));
762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782
    
    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;
783
    my $metadata_type;
784
    my $already_exists =
785 786
	$self->LookupMetadata($name,
			      \$parent_guid, \$parent_vers, \$metadata_type);
787 788 789 790
    return -1
	if ($already_exists <= 0);

    $name  = DBQuoteSpecial($name);
791
    $value = DBQuoteSpecial(encode_entities($value));
792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832

    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 ...
    #
833 834 835 836 837 838 839 840 841
    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
842
	    Template::mysystem("$makegraph $template_guid");
843 844 845 846 847 848 849 850 851 852 853 854 855
	}
	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' ".
856 857 858
			"where parent_guid='$template_guid' and ".
			"      parent_vers='$template_vers' and ".
			"      name=$name")
859 860
		or return -1
	}
861 862 863 864 865
    }
    return 0;
}

#
866
# Add a formal parameter to a template.
867
#
868
sub NewFormalParameter($$$$$)
869
{
870
    my ($self, $name, $value, $description, $dbuid) = @_;
871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894

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

895 896 897 898 899 900
    if (defined($description) && $description ne "") {
	$self->NewMetadata($name,
			   $description, $dbuid, "parameter_description")
	    == 0 or return -1;
    }

901 902 903
    return 0;
}

904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933
#
# 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;
}

934 935 936 937 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
#
# 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;
}

968
#
969
# Delete (all) template metadata
970
#
971
sub DeleteAllMetadata($)
972
{
973 974 975 976 977 978 979 980
    my ($self) = @_;

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

    my $template_guid = $self->guid();
    my $template_vers = $self->vers();
981 982 983 984 985

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

    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 ".
1020
		"      parent_vers='$template_vers'")
1021 1022 1023 1024 1025
	or return -1;

    return 0;
}

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 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067
#
# 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;
}

1068 1069 1070 1071
#
# Copy exiting template metadata to a child. This is likely to change
# since we probably want to share at some point.
#
1072
sub CopyMetadata($$$)
1073
{
1074
    my ($self, $parent, $copier) = @_;
1075 1076 1077

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

1080 1081 1082
    my $from_guid = $parent->guid();
    my $from_vers = $parent->vers();
    my $to_vers   = $self->vers();
1083 1084 1085 1086 1087

    #
    # Copy the toplevel items.
    #
    my $query_result =
1088
	DBQueryWarn("select name,value,metadata_type,internal,i.parent_guid ".
1089 1090 1091 1092 1093
		    "  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 ".
1094
		    "      m.parent_vers='$from_vers'")
1095 1096
	or return -1;

1097
    while (my ($name,$value,$type,$internal,$hasparent) =
1098 1099
	   $query_result->fetchrow_array()) {

1100 1101
	my $guid;
	my $version = 1;
1102
	my $metadata_type = "NULL";
1103 1104
	my $parent_guid;
	my $parent_vers;
1105 1106 1107 1108
	
	$name   = DBQuoteSpecial($name);
	$value  = DBQuoteSpecial($value);

1109 1110 1111 1112 1113 1114 1115 1116
	#
	# 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");

1117 1118 1119 1120
	    #
	    # XXX Skip parameters that were deleted or whose description
	    # was modified after being created.
	    #
1121 1122 1123 1124
	    if ($type eq "parameter_description") {
		my $param_result = 
		    DBQueryWarn("select * ".
				"   from experiment_template_parameters ".
1125 1126 1127
				"where parent_guid='$from_guid' and ".
				"      parent_vers='$to_vers' and ".
				"      name=$name");
1128 1129 1130 1131 1132 1133

		return -1
		    if (!$param_result);
		
		next
		    if (!$param_result->numrows);
1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157

		#
		# 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;
		}
1158 1159 1160 1161
	    }
	    $metadata_type = "'$type'";
	}

1162
	return -1
1163
	    if (!defined($guid) && NewGUID(\$guid) < 0);
1164 1165 1166

	DBQueryWarn("insert into experiment_template_metadata set ".
		    "   parent_guid='$from_guid', ".
1167
		    "   parent_vers='$to_vers', ".
1168 1169
		    "   metadata_guid='$guid', ".
		    "   metadata_vers='$version', ".
1170 1171
		    "   metadata_type=$metadata_type, ".
		    "   internal=$internal")
1172 1173 1174
	    or return -1;

	DBQueryWarn("insert into experiment_template_metadata_items set ".
1175
		    "   guid='$guid', vers='$version', uid='$copier', ".
1176
		    "   template_guid='$from_guid', ".
1177 1178 1179
		    (! defined($parent_guid) ? "" :
		     "  parent_guid='$parent_guid',".
		     "  parent_vers='$parent_vers',") .
1180 1181 1182
		    "   name=$name, value=$value, created=now()")
	    or return -1;

1183 1184 1185 1186 1187 1188 1189 1190
	#
	# 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' ".
1191 1192 1193
			    "where parent_guid='$from_guid' and ".
			    "      parent_vers='$to_vers' and ".
			    "      name=$name")
1194 1195 1196 1197
		    or return -1
		}
	}
    }
1198 1199 1200
    return 0;
}

1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245
#
# 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;
}

1246
#
1247
# Create a new Instance record, using the package below.
1248
#
1249
sub NewInstance($$$)