Template.pm.in 94.8 KB
Newer Older
1 2 3
#!/usr/bin/perl -wT
#
# EMULAB-COPYRIGHT
4
# Copyright (c) 2005-2010 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

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

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

# Must come after package declaration!
use libdb;
use libtestbed;
use libtblog;
22
use libArchive;
23 24
use Archive;
use Project;
25
use User;
26
use Experiment;
27
use Group;
28
use Logfile;
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 Stoller's avatar
Leigh 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 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125
    my ($class, $arg1, $arg2) = @_;
    my ($guid, $vers);

    #
    # A single arg is either an index or a "guid,vers" or "guid/vers" string.
    #
    if (!defined($arg2)) {
	if ($arg1 =~ /^([-\w]*),([-\w]*)$/ ||
	    $arg1 =~ /^([-\w]*)\/([-\w]*)$/) {
	    $guid = $1;
	    $vers = $2;
	}
	else {
	    return undef;
	}
    }
    elsif (! (($arg1 =~ /^[-\w]*$/) && ($arg2 =~ /^[-\w]*$/))) {
	return undef;
    }
    else {
	$guid = $arg1;
	$vers = $arg2;
    }
126

127 128 129 130
    # Look in cache first
    return $templates{"$guid/$vers"}
        if (exists($templates{"$guid/$vers"}));
    
131
    my $query_result =
132 133
	DBQueryWarn("select * from experiment_templates ".
		    "where guid='$guid' and vers='$vers'");
134

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

138 139 140 141 142
    my $self             = {};
    $self->{'TEMPLATE'}  = $query_result->fetchrow_hashref();
    # Filled lazily.
    $self->{'INSTANCES'} = undef;
    bless($self, $class);
143
    
144 145 146 147
    # Add to cache. 
    $templates{"$guid/$vers"} = $self;
    
    return $self;
148
}
149 150 151 152
# 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'}); }
153
sub pid_idx($) { return ((! ref($_[0])) ? -1 : $_[0]->{'TEMPLATE'}->{'pid_idx'}); }
154
sub gid($)  { return ((! ref($_[0])) ? -1 : $_[0]->{'TEMPLATE'}->{'gid'}); }
155
sub gid_idx($)  { return ((! ref($_[0])) ? -1 : $_[0]->{'TEMPLATE'}->{'gid_idx'}); }
156
sub eid($)  { return ((! ref($_[0])) ? -1 : $_[0]->{'TEMPLATE'}->{'eid'}); }
157
sub exptidx($) { return ((! ref($_[0])) ? -1 : $_[0]->{'TEMPLATE'}->{'exptidx'}); }
158
sub tid($)  { return ((! ref($_[0])) ? -1 : $_[0]->{'TEMPLATE'}->{'tid'}); }
159
sub path($) { return ((! ref($_[0])) ? -1 : $_[0]->{'TEMPLATE'}->{'path'}); }
160 161
sub archive_idx($) {
    return ((! ref($_[0])) ? -1 : $_[0]->{'TEMPLATE'}->{'archive_idx'}); }
162 163 164 165
sub parent_guid($) {
    return ((! ref($_[0])) ? -1 : $_[0]->{'TEMPLATE'}->{'parent_guid'}); }
sub IsRoot($) {
    return ! defined($_[0]->{'TEMPLATE'}->{'parent_guid'}); }
166 167 168 169 170 171
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'}); }
172 173 174 175
sub logfile($) {
    return ((! ref($_[0])) ? -1 : $_[0]->{'TEMPLATE'}->{'logfile'}); }
sub logfile_open($) {
    return ((! ref($_[0])) ? -1 : $_[0]->{'TEMPLATE'}->{'logfile_open'}); }
176 177
sub active($) {
    return ((! ref($_[0])) ? -1 : $_[0]->{'TEMPLATE'}->{'active'}); }
178 179

#
180
# Lookup a template given an experiment index.
181
#
182
sub LookupByExptidx($$)
183
{
184
    my ($class, $exptidx) = @_;
185

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

189 190
    return undef
	if (!defined($template_instance));
191

192
    return $template_instance->template();
193 194
}

195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214
#
# 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);
}

215 216 217 218 219 220 221 222 223 224 225 226 227 228
#
# Return the underlying experiment object for the template itself.
#
sub GetExperiment($)
{
    my ($self) = @_;

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

    return Experiment->LookupByIndex($self->exptidx());
}

229
#
230
# Refresh a template instance by reloading from the DB.
231
#
232
sub Refresh($)
233
{
234
    my ($self) = @_;
235

236 237
    return -1
	if (! ref($self));
238

239 240 241 242 243 244
    my $guid = $self->guid();
    my $vers = $self->vers();
    
    my $query_result =
	DBQueryWarn("select * from experiment_templates ".
		    "where guid='$guid' and vers='$vers'");
245 246

    return -1
247 248 249
	if (!$query_result || !$query_result->numrows);
	
    $self->{'TEMPLATE'} = $query_result->fetchrow_hashref();
250 251 252
    return 0;
}

253
#
254 255
# Create a new template. This installs the new record in the DB,
# and returns an instance. There is some bookkeeping along the way.
256
#
257
sub Create($$)
258
{
259 260
    my ($class, $argref) = @_;
    my ($guid, $vers);
261

262 263
    return undef
	if (ref($class));
264

Leigh Stoller's avatar
Leigh Stoller committed
265 266 267 268 269 270 271 272 273
    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;
    }

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

289 290 291
    DBQueryWarn("lock tables experiments write, ".
		"            experiment_templates write")
	or return undef;
292

293 294 295 296 297 298 299
    #
    # 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'");
300

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

306 307 308
	$vers = ($query_result->fetchrow_array())[0];
	$vers++;
    }
309

310 311 312
    # 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}";
313 314 315

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

317
    #
318
    # Sanity check; make sure this eid is not in use. Tables are still locked.
319 320
    #
    my $query_result =
321 322
	DBQueryWarn("select pid,eid from experiments ".
		    "where eid='$eid' and pid='$pid'");
323

324 325 326 327 328 329 330 331 332
    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;
333 334
    }

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

338 339
    # Append the rest
    $query .= ",created=now(),guid='$guid',vers='$vers',eid='$eid'";
340

341 342 343 344 345 346 347
    if (! DBQueryWarn($query)) {
	DBQueryWarn("unlock tables");
	return undef;
    }
    DBQueryWarn("unlock tables");

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

#
351
# Stringify for output.
352
#
353
sub Stringify($)
354
{
355 356 357
    my ($self) = @_;
    my $guid   = $self->guid();
    my $vers   = $self->vers();
358

359
    return "[Template: $guid/$vers]";
360 361
}

362
#
363
# Update a template record given an array reference of slot/value pairs.
364
#
365
sub Update($$)
366
{
367
    my ($self, $argref) = @_;
368

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

373 374
    my $guid = $self->guid();
    my $vers = $self->vers();
375

376 377 378 379
    my $query = "update experiment_templates set ".
	join(",", map("$_='" . $argref->{$_} . "'", keys(%{$argref})));

    $query .= " where guid='$guid' and vers='$vers'";
380 381 382

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

    return Refresh($self);
385 386
}

387
#
388 389
# Delete a template (all tables). Note that other parts of the template
# like instances must already be gone when this is called.
390
#
391
sub Delete($)
392
{
393
    my ($self) = @_;
394

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

399 400
    my $guid = $self->guid();
    my $vers = $self->vers();
401 402 403 404 405 406
    my $path = $self->path();

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

408
    DeleteAllMetadata($self) == 0
409
	or return -1;
410

411 412
    DeleteInputFiles($self) == 0
	or return -1;
413

414 415 416 417 418
    my $logfile = $self->GetLogFile();
    if (defined($logfile)) {
	$logfile->Delete();
    }

419 420 421 422
    # 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'");
423 424 425
    return -1
	if (! $query_result);

426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449
    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;
450 451 452
    return 0;
}

453 454 455
#
# Logfiles. This all needs to change.
#
456
# Open a new logfile and return it.
457
#
458
sub CreateLogFile($$)
459
{
460
    my ($self, $prefix) = @_;
461 462

    # Must be a real reference. 
463
    return undef
464 465 466 467 468 469 470
	if (! ref($self));

    my $vers     = $self->vers();
    my $guid     = $self->guid();
    my $pid      = $self->pid();
    my $projroot = PROJROOT();
    my $logdir   = "$projroot/$pid/templates/logs";
471
    my $linkname = "$logdir/$prefix.${guid}-${vers}.log";
472

473
    return undef
474 475
	if (! -d $logdir && !mkdir($logdir, 0775));

476
    my $logname  = `mktemp $logdir/$prefix.${guid}-${vers}.XXXXXX`;
477 478 479
    return undef
	if ($?);
    chomp($logname);
480

481 482 483 484 485
    # Create a Logfile.
    my $logfile = Logfile->Create($self->gid_idx(), $logname);
    if (!defined($logfile)) {
	unlink($logname);
	return undef;
486
    }
487 488 489 490 491 492 493 494 495
    # This is untainted.
    $logname = $logfile->filename();

    unlink($linkname)
	if (-e $linkname);
    if (Template::mysystem("touch $logname")) {
	$logfile->Delete();
	unlink($logname);
	return undef;
496 497 498
    }
    if (! link($logname, $linkname)) {
	print STDERR "*** Cannot link $logname,$linkname: $!\n";
499 500 501
	$logfile->Delete();
	unlink($logname);
	return undef;
502
    }
503
    return $logfile;
504 505 506 507 508 509 510
}

#
# Set the experiment to use the logfile. It becomes the "current" spew.
#
sub SetLogFile($$)
{
511
    my ($self, $logfile) = @_;
512 513 514

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

517 518 519 520 521 522
    # Kill the old one. Eventually we will save them.
    my $oldlogfile = $self->GetLogFile();
    if (defined($oldlogfile)) {
	$oldlogfile->Delete();
    }
    return $self->Update({'logfile' => $logfile->logid()});
523 524 525 526 527
}

#
# Get the experiment logfile.
#
528
sub GetLogFile($)
529
{
530
    my ($self) = @_;
531 532

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

    # Must do this to catch updates to the logfile variables.
537
    return undef
538 539
	if ($self->Refresh());

540
    return undef
541 542
	if (! $self->logfile());

543
    return Logfile->Lookup($self->logfile());
544 545 546 547 548 549 550 551 552 553 554 555 556
}

#
# Mark the log as open so that the spew keeps looking for more output.
# 
sub OpenLogFile($)
{
    my ($self) = @_;

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

557 558 559 560 561
    my $logfile = $self->GetLogFile();
    return -1
	if (!defined($logfile));

    return $logfile->Open();
562 563 564 565 566 567 568 569 570 571 572 573 574
}

#
# And close it ...
#
sub CloseLogFile($)
{
    my ($self) = @_;

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

575 576 577 578 579
    my $logfile = $self->GetLogFile();
    return -1
	if (!defined($logfile));

    return $logfile->Close();
580 581 582 583 584 585 586 587 588 589 590 591 592
}

#
# And clear it ...
#
sub ClearLogFile($)
{
    my ($self) = @_;

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

593 594 595 596 597 598 599
    my $logfile = $self->GetLogFile();
    return -1
	if (!defined($logfile));

    $logfile->Delete() == 0
	or return -1;

600 601 602 603
    my $guid = $self->guid();
    my $vers = $self->vers();

    if (!DBQueryWarn("update experiment_templates set ".
604
		     "    logfile=NULL ".
605 606 607 608 609 610
		     "where guid='$guid' and vers='$vers'")) {
	return -1;
    }
    return $self->Refresh();
}

611
#
612
# Template permission checks. Using the experiment access check stuff.
613
#
614 615 616
# Usage: AccessCheck($guid, $uid, $access_type)
#	 returns 0 if not allowed.
#        returns 1 if allowed.
617
#
618
sub AccessCheck($$$;$)
619
{
620
    my ($self, $guid, $user, $access_type);
621 622 623 624 625 626
    my $mintrust;
    
    #
    # If called as a method, no guid argument is provided. 
    #
    $self = shift();
627

628
    if (ref($self)) {
629
	($user, $access_type) = @_;
630 631
    }
    else {
632
	($guid, $user, $access_type) = @_;
633

634 635 636 637 638 639 640 641 642
	$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!");
    }
643

644 645 646
    #
    # Admins do whatever they want!
    #
647
    if (TBAdmin()) {
648 649
	return 1;
    }
650

651 652 653 654 655 656 657 658 659 660
    #
    # Transition to using user objects instead of uids
    #
    if (! ref($user)) {
	my $uid = MapNumericUID($user);

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

662
    #
663
    # A template may be destroyed by the creator or the project/group leader.
664 665 666 667 668 669 670 671
    #
    if ($access_type == TB_EXPT_READINFO) {
	$mintrust = PROJMEMBERTRUST_USER;
    }
    else {
	$mintrust = PROJMEMBERTRUST_LOCALROOT;
    }

672 673 674 675 676 677 678
    #
    # Map to group object.
    #
    my $group = Group->Lookup($self->gid_idx());
    return 0
	if (!defined($group));

679 680 681 682 683
    #
    # 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.
    #
684 685 686 687 688 689 690 691 692 693 694 695 696 697 698
    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;
699 700
}

701
#
702
# Return a list of all children of the given template.
703
#
704
sub Children($$)
705
{
706
    my ($self, $resultp) = @_;
707

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

712 713 714 715 716 717 718 719 720 721
    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");
722
    return -1
723
	if (!$query_result);
724

725 726 727
    while (my ($vers, $parent_vers) = $query_result->fetchrow_array()) {
	$children{$parent_vers} = []
	    if (!exists($children{$parent_vers}));
728

729 730 731 732 733 734 735 736 737 738 739 740 741 742
	# 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);
743

744 745 746 747 748 749
	# New children of kid
	unshift(@allkids, @{ $children{$kid} })
	    if (exists($children{$kid}));
    }
    # Most recent templates first.
    @kids = sort {$b <=> $a} @kids;
750

751 752 753 754 755 756 757
    # Now convert to template objects.
    foreach my $vers (@kids) {
	my $template = Template->Lookup($guid, $vers);
	return -1
	    if (! $template);
	push(@result, $template);
    }
758

759
    @$resultp = @result;
760 761 762 763
    return 0;
}

#
764 765 766 767 768
# 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($$)
769
{
770 771
    my ($self, $inputfile) = @_;
    my $input_data_idx;
772

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

777
    my $data_string = `cat $inputfile`;
778 779 780
    return -1
	if ($?);

781 782 783 784
    my $guid = $self->guid();
    my $vers = $self->vers();
    my $pid  = $self->pid();
    my $tid  = $self->tid();
785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800

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

801 802 803 804
	DBQueryWarn("lock tables experiment_template_inputs write, ".
		    "            experiment_template_input_data write")
	    or return -1;

805 806 807 808
	my $query_result =
	    DBQueryWarn("select idx from experiment_template_input_data ".
			"where md5='$md5'");

809 810 811 812
	if (!$query_result) {
	    DBQueryWarn("unlock tables");
	    return -1;
	}
813 814

	if ($query_result->numrows) {
815
	    ($input_data_idx) = $query_result->fetchrow_array();
816 817 818 819 820 821 822
	}
	else {
	    $query_result =
		DBQueryWarn("insert into experiment_template_input_data ".
			    "(idx, md5, input) ".
			    "values (NULL, '$md5', $data_string)");
	    
823 824 825 826 827
	    if (!$query_result) {
		DBQueryWarn("unlock tables");
		return -1;
	    }
	    $input_data_idx = $query_result->insertid;
828 829
	}

830 831 832 833
	$query_result =
	    DBQueryWarn("insert into experiment_template_inputs ".
			" (idx, parent_guid, parent_vers, ".
			"  pid, tid, input_idx) values ".
834
			" (NULL, '$guid', '$vers', '$pid', '$tid', ".
835 836
			"  '$input_data_idx')");
	DBQueryWarn("unlock tables");
837
	return -1
838
	    if (!$query_result);
839 840 841 842
    }
    return 0;
}

843
#
844
# Delete all input files, say for a template create/modify that fails.
845
#
846
sub DeleteInputFiles($)
847
{
848
    my ($self) = @_;
849

850 851 852 853 854 855 856
    # Must be a real reference. 
    return -1
	if (! ref($self));

    my $guid = $self->guid();
    my $vers = $self->vers();
    
857 858
    DBQueryWarn("lock tables experiment_template_inputs as i write, ".
		"            experiment_template_inputs as j write, ".
859
		"            experiment_template_inputs write, ".
860 861 862 863 864 865 866 867 868 869 870 871 872 873
		"            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 ".
874
		    "      i.parent_vers='$vers' ".
875 876 877 878 879 880 881 882 883 884 885 886 887
		    "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 ".
888
		    "where parent_guid='$guid' and parent_vers='$vers'");
889 890 891 892 893 894 895 896
    DBQueryWarn("unlock tables");
    
    return -1
	if (! $query_result);

    return 0;
}

897
#
898
# Add a metadata record. 
899
#
900
sub NewMetadata($$$$;$)
901
{
902
    my ($self, $name, $value, $creator, $type) = @_;
903
    my $guid;
904 905
    my $version  = 1;
    my $internal = 0;
906
    my $metadata_type;
907

908
    # Must be a real reference. 
909
    return -1
910 911 912 913
	if (! ref($self));

    my $template_guid = $self->guid();
    my $template_vers = $self->vers();
914 915
    my $creator_uid   = $creator->uid();
    my $creator_dbid  = $creator->uid_idx();
916 917 918 919 920 921

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

    # Special ...
    $internal = 1
922
	if (defined($type));
923

924
    # Current set of allowed types;
925
    my @okay_types = ("tid", "template_description", "parameter_description",
926
		      "annotation", "instance_description", "run_description");
927 928 929 930 931 932 933 934 935 936 937 938 939

    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);
940 941
    # HTML entity encode; yep, plain text only.
    my $safevalue = DBQuoteSpecial(encode_entities($value));
942 943 944

    my $query_result =
	DBQueryWarn("insert into experiment_template_metadata_items set ".
945 946
		    "   guid='$guid', vers='$version', ".
		    "   uid='$creator_uid', uid_idx='$creator_dbid', ".
947
		    "   template_guid='$template_guid', ".
948
		    "   name=$safename, value=$safevalue, created=now()");
949 950 951 952 953
    return -1
	if (!$query_result);

    DBQueryWarn("insert into experiment_template_metadata set ".
		"   parent_guid='$template_guid', ".
954
		"   parent_vers='$template_vers', ".
955 956
		"   metadata_guid='$guid', ".
		"   metadata_vers='$version', ".
957
		"   metadata_type=$metadata_type, ".
958
		"   internal=$internal")
959
	or return -1;
960 961 962 963

    # Some metadata is special ...
    if (defined($type)) {
	if ($type eq "parameter_description") {
964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989
	    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;
990 991
	}
    }
992 993 994 995
    
    return 0;
}

996 997 998
#
# Lookup a metadata value by name, optionally returning guid/vers.
#
999
sub LookupMetadata($$;$$$)
1000
{
1001
    my ($self, $name, $pguid, $pvers, $ptype) = @_;
1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012

    # 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 =
1013
	DBQueryWarn("select metadata_guid,metadata_vers,metadata_type ".
1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025
		    "   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);

1026 1027
    my ($metadata_guid, $metadata_vers, $metadata_type) =
	$query_result->fetchrow_array();
1028 1029 1030 1031
    $$pguid = $metadata_guid
	if (defined($pguid));
    $$pvers = $metadata_vers
	if (defined($pvers));
1032 1033
    $$ptype = $metadata_type
	if (defined($ptype));
1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052
    
    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();
1053 1054
    my $creator_uid   = $creator->uid();
    my $creator_dbid  = $creator->uid_idx();
1055 1056
    my $parent_guid;
    my $parent_vers;
1057
    my $metadata_type;
1058
    my $already_exists =
1059 1060
	$self->LookupMetadata($name,
			      \$parent_guid, \$parent_vers, \$metadata_type);
1061 1062 1063
    return -1
	if ($already_exists <= 0);

1064 1065
    my $safename  = DBQuoteSpecial($name);
    my $safevalue = DBQuoteSpecial(encode_entities($value));
1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085

    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', ".
1086 1087
		     "     template_guid='$template_guid', ".
		     "     uid='$creator_uid', uid_idx='$creator_dbid', ".
1088 1089
		     "     parent_guid='$parent_guid',".
		     "     parent_vers='$parent_vers'," .
1090
		     "     name=$safename, value=$safevalue, created=now()")) {
1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107
	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 ...
    #
1108 1109
    if (defined($metadata_type)) {
	if ($metadata_type eq "tid") {
1110
	    DBQueryWarn("update experiment_templates set tid=$safevalue ".
1111 1112 1113 1114 1115 1116
			"where guid='$template_guid' and ".
			"      vers='$template_vers'")
		or return -1;
	    
	    Refresh($self);
	    # This can fail; it is not critical.
Leigh Stoller's avatar
Leigh Stoller committed
1117
	    Template::mysystem("$makegraph $template_guid");
1118 1119
	}
	elsif ($metadata_type eq "template_description") {
1120 1121
	    DBQueryWarn("update experiment_templates set ".
			"   description=$safevalue ".
1122 1123 1124 1125 1126 1127 1128 1129 1130 1131
			"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' ".
1132 1133
			"where parent_guid='$template_guid' and ".
			"      parent_vers='$template_vers' and ".
1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154
			"      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;
1155
	}
1156 1157 1158 1159 1160
    }
    return 0;
}

#
1161
# Add a formal parameter to a template.
1162
#
1163
sub NewFormalParameter($$$$$)
1164
{
1165
    my ($self, $name, $value, $description, $user) = @_;
1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189

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

1190 1191
    if (defined($description) && $description ne "") {
	$self->NewMetadata($name,
1192
			   $description, $user, "parameter_description")
1193 1194 1195
	    == 0 or return -1;
    }

1196 1197 1198
    return 0;
}

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

1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262
#
# 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;
}

1263
#
1264
# Delete (all) template metadata
1265
#
1266
sub DeleteAllMetadata($)
1267
{
1268 1269 1270 1271 1272 1273 1274 1275
    my ($self) = @_;

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

    my $template_guid = $self->guid();
    my $template_vers = $self->vers();
1276 1277 1278 1279 1280

    my $query_result =
	DBQueryWarn("select metadata_guid ".
		    "    from experiment_template_metadata ".
		    "where parent_guid='$template_guid' and ".
1281
		    "      parent_vers='$template_vers'");
1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314

    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 ".
1315
		"      parent_vers='$template_vers'")
1316 1317 1318 1319 1320
	or return -1;

    return 0;
}

1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362
#
# 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;
}

1363 1364 1365 1366
#
# Copy exiting template metadata to a child. This is likely to change
# since we probably want to share at some point.
#
1367
sub CopyMetadata($$$)
1368
{
1369
    my ($self, $parent, $copier) = @_;
1370 1371 1372

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

1375 1376 1377
    my $from_guid = $parent->guid();
    my $from_vers = $parent->vers();
    my $to_vers   = $self->vers();
1378 1379
    my $copier_uid  = $copier->uid();
    my $copier_dbid = $copier->uid_idx();
1380 1381 1382 1383 1384

    #
    # Copy the toplevel items.
    #
    my $query_result =
1385
	DBQueryWarn("select name,value,metadata_type,internal,i.parent_guid ".
1386 1387 1388 1389 1390
		    "  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 ".
1391
		    "      m.parent_vers='$from_vers'")
1392 1393
	or return -1;

1394
    while (my ($name,$value,$type,$internal,$hasparent) =
1395 1396
	   $query_result->fetchrow_array()) {

1397 1398
	my $guid;
	my $version = 1;
1399
	my $metadata_type = "NULL";
1400 1401
	my $parent_guid;
	my $parent_vers;
1402 1403 1404 1405
	
	$name   = DBQuoteSpecial($name);
	$value  = DBQuoteSpecial($value);

1406 1407 1408 1409
	#
	# XXX Some metadata is special ...
	#
	if (defined($type)) {
1410
	    # XXX Skip the tid and template descriptions and annotations.
1411
	    next
1412 1413 1414
		if ($type eq "tid" ||
		    $type eq "template_description" ||
		    $type eq "annotation");
1415

1416 1417 1418 1419
	    #
	    # XXX Skip parameters that were deleted or whose description
	    # was modified after being created.
	    #
1420 1421 1422 1423
	    if ($type eq "parameter_description") {
		my $param_result = 
		    DBQueryWarn("select * ".
				"   from experiment_template_parameters ".
1424 1425 1426
				"where parent_guid='$from_guid' and ".
				"      parent_vers='$to_vers' and ".
				"      name=$name");
1427 1428 1429 1430 1431 1432

		return -1
		    if (!$param_result);
		
		next
		    if (!$param_result->numrows);
1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456

		#
		# 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;
		}
1457 1458 1459 1460
	    }
	    $metadata_type = "'$type'";
	}

1461
	return -1
1462
	    if (!defined($guid) && NewGUID(\$guid) < 0);
1463 1464 1465

	DBQueryWarn("insert into experiment_template_metadata set ".
		    "   parent_guid='$from_guid', ".
1466
		    "   parent_vers='$to_vers', ".
1467 1468
		    "   metadata_guid='$guid', ".
		    "   metadata_vers='$version', ".
1469 1470
		    "   metadata_type=$metadata_type, ".
		    "   internal=$internal")
1471 1472 1473
	    or return -1;

	DBQueryWarn("insert into experiment_template_metadata_items set ".
1474 1475
		    "   guid='$guid', vers='$version', ".
		    "   uid='$copier_uid', uid_idx='$copier_dbid', ".
1476
		    "   template_guid='$from_guid', ".
1477 1478 1479
		    (! defined($parent_guid) ? "" :
		     "  parent_guid='$parent_guid',".
		     "  parent_vers='$parent_vers',") .
1480 1481 1482
		    "   name=$name, value=$value, created=now()")
	    or return -1;

1483 1484 1485 1486 1487 1488 1489 1490
	#
	# 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' ".
1491 1492 1493
			    "where parent_guid='$from_guid' and ".
			    "      parent_vers='$to_vers' and ".
			    "      name=$name")
1494 1495 1496 1497
		    or return -1
		}
	}
    }
1498 1499 1500
    return 0;
}

1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545
#
# 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;
}

1546
#
1547
# Create a new Instance record, using the package below.
1548
#
1549
sub NewInstance($$$;$)
1550
{
1551
    my ($self, $eid, $creator, $description) = @_;
1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562

    # 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;
1563 1564
    $args{'uid'}         = $creator->uid();
    $args{'uid_idx'}     = $creator->uid_idx();
1565

1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579
    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;
1580 1581
}

1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605
#
# 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;
}

1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639
#
# 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);
1640
    
1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656
    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;
}

1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671
#
# Change description
#
sub SetDescription($$)
{
    my ($self, $description) = @_;

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

    return $self->ModifyMetadata("description", $description,
				 User->ThisUser(), "template_description");
}

1672 1673 1674
#
# Copy the datastore from parent template to child template.
#
1675
sub CopyDataStore($$)
1676 1677 1678 1679 1680 1681 1682 1683 1684 1685
{
    my ($self, $parent) = @_;

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

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

Leigh Stoller's avatar
Leigh Stoller committed
1686 1687
    Template::mysystem("cd $from_path; ".
		       "   $RSYNC -rtgoDlz datastore $to_path") == 0
1688 1689 1690 1691 1692
	or return -1;

    return 0;
}

1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709