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

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

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

# Must come after package declaration!
use lib '@prefix@/lib';
use libdb;
use libtestbed;
use libtblog;
23
use libArchive;
24 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 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

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

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

187 188
    return undef
	if (!defined($template_instance));
189

190
    return $template_instance->template();
191 192
}

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

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

Leigh B. Stoller's avatar
Leigh B. Stoller committed
227
#
228
# Refresh a template instance by reloading from the DB.
Leigh B. Stoller's avatar
Leigh B. Stoller committed
229
#
230
sub Refresh($)
Leigh B. Stoller's avatar
Leigh B. Stoller committed
231
{
232
    my ($self) = @_;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
233

234 235
    return -1
	if (! ref($self));
Leigh B. Stoller's avatar
Leigh B. Stoller committed
236

237 238 239 240 241 242
    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
243 244

    return -1
245 246 247
	if (!$query_result || !$query_result->numrows);
	
    $self->{'TEMPLATE'} = $query_result->fetchrow_hashref();
Leigh B. Stoller's avatar
Leigh B. Stoller committed
248 249 250
    return 0;
}

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

260 261
    return undef
	if (ref($class));
262

Leigh B. Stoller's avatar
Leigh B. Stoller committed
263 264 265 266 267 268 269 270 271
    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;
    }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

357
    return "[Template: $guid/$vers]";
358 359
}

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

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

371 372
    my $guid = $self->guid();
    my $vers = $self->vers();
373

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

    $query .= " where guid='$guid' and vers='$vers'";
378 379 380

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

    return Refresh($self);
383 384
}

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

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

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

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

406
    DeleteAllMetadata($self) == 0
407
	or return -1;
408

409 410
    DeleteInputFiles($self) == 0
	or return -1;
411

412 413 414 415
    # 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'");
416 417 418
    return -1
	if (! $query_result);

419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442
    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;
443 444 445
    return 0;
}

446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565
#
# Logfiles. This all needs to change.
#
# Open a new logfile and return its name.
#
sub CreateLogFile($$$)
{
    my ($self, $prefix, $ppath) = @_;

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

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

    return -1
	if (-e $logname);

    return -1
	if (! -d $logdir && !mkdir($logdir, 0775));

    Template::mysystem("touch $logname") == 0
	    or return -1;

    $$ppath = $logname;
    return 0;
}

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

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

    return $self->Update({'logfile' => $logname});
}

#
# Get the experiment logfile.
#
sub GetLogFile($$$)
{
    my ($self, $lognamep, $isopenp) = @_;

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

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

    return -1
	if (! $self->logfile());

    $$lognamep = $self->logfile();
    $$isopenp  = $self->logfile_open();
    return 0;
}

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

    return $self->Update({'logfile_open' => 1});
}

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

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

    return $self->Update({'logfile_open' => 0});
}

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

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

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

    if (!DBQueryWarn("update experiment_templates set ".
		     "logfile=NULL,logfile_open=0 ".
		     "where guid='$guid' and vers='$vers'")) {
	return -1;
    }
    return $self->Refresh();
}

566
#
567
# Template permission checks. Using the experiment access check stuff.
568
#
569 570 571
# Usage: AccessCheck($guid, $uid, $access_type)
#	 returns 0 if not allowed.
#        returns 1 if allowed.
572
#
573
sub AccessCheck($$$;$)
574
{
575
    my ($self, $guid, $user, $access_type);
576 577 578 579 580 581
    my $mintrust;
    
    #
    # If called as a method, no guid argument is provided. 
    #
    $self = shift();
582

583
    if (ref($self)) {
584
	($user, $access_type) = @_;
585 586
    }
    else {
587
	($guid, $user, $access_type) = @_;
588

589 590 591 592 593 594 595 596 597
	$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!");
    }
598

599 600 601
    #
    # Admins do whatever they want!
    #
602
    if (TBAdmin()) {
603 604
	return 1;
    }
605

606 607 608 609 610 611 612 613 614 615
    #
    # Transition to using user objects instead of uids
    #
    if (! ref($user)) {
	my $uid = MapNumericUID($user);

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

617
    #
618
    # A template may be destroyed by the creator or the project/group leader.
619 620 621 622 623 624 625 626
    #
    if ($access_type == TB_EXPT_READINFO) {
	$mintrust = PROJMEMBERTRUST_USER;
    }
    else {
	$mintrust = PROJMEMBERTRUST_LOCALROOT;
    }

627 628 629 630 631 632 633
    #
    # Map to group object.
    #
    my $group = Group->Lookup($self->gid_idx());
    return 0
	if (!defined($group));

634 635 636 637 638
    #
    # 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.
    #
639 640 641 642 643 644 645 646 647 648 649 650 651 652 653
    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;
654 655
}

656
#
657
# Return a list of all children of the given template.
658
#
659
sub Children($$)
660
{
661
    my ($self, $resultp) = @_;
662

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

667 668 669 670 671 672 673 674 675 676
    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");
677
    return -1
678
	if (!$query_result);
679

680 681 682
    while (my ($vers, $parent_vers) = $query_result->fetchrow_array()) {
	$children{$parent_vers} = []
	    if (!exists($children{$parent_vers}));
683

684 685 686 687 688 689 690 691 692 693 694 695 696 697
	# 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);
698

699 700 701 702 703 704
	# New children of kid
	unshift(@allkids, @{ $children{$kid} })
	    if (exists($children{$kid}));
    }
    # Most recent templates first.
    @kids = sort {$b <=> $a} @kids;
705

706 707 708 709 710 711 712
    # Now convert to template objects.
    foreach my $vers (@kids) {
	my $template = Template->Lookup($guid, $vers);
	return -1
	    if (! $template);
	push(@result, $template);
    }
713

714
    @$resultp = @result;
715 716 717 718
    return 0;
}

#
719 720 721 722 723
# 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($$)
724
{
725 726
    my ($self, $inputfile) = @_;
    my $input_data_idx;
727

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

732
    my $data_string = `cat $inputfile`;
733 734 735
    return -1
	if ($?);

736 737 738 739
    my $guid = $self->guid();
    my $vers = $self->vers();
    my $pid  = $self->pid();
    my $tid  = $self->tid();
740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755

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

756 757 758 759
	DBQueryWarn("lock tables experiment_template_inputs write, ".
		    "            experiment_template_input_data write")
	    or return -1;

760 761 762 763
	my $query_result =
	    DBQueryWarn("select idx from experiment_template_input_data ".
			"where md5='$md5'");

764 765 766 767
	if (!$query_result) {
	    DBQueryWarn("unlock tables");
	    return -1;
	}
768 769

	if ($query_result->numrows) {
770
	    ($input_data_idx) = $query_result->fetchrow_array();
771 772 773 774 775 776 777
	}
	else {
	    $query_result =
		DBQueryWarn("insert into experiment_template_input_data ".
			    "(idx, md5, input) ".
			    "values (NULL, '$md5', $data_string)");
	    
778 779 780 781 782
	    if (!$query_result) {
		DBQueryWarn("unlock tables");
		return -1;
	    }
	    $input_data_idx = $query_result->insertid;
783 784
	}

785 786 787 788
	$query_result =
	    DBQueryWarn("insert into experiment_template_inputs ".
			" (idx, parent_guid, parent_vers, ".
			"  pid, tid, input_idx) values ".
789
			" (NULL, '$guid', '$vers', '$pid', '$tid', ".
790 791
			"  '$input_data_idx')");
	DBQueryWarn("unlock tables");
792
	return -1
793
	    if (!$query_result);
794 795 796 797
    }
    return 0;
}

798
#
799
# Delete all input files, say for a template create/modify that fails.
800
#
801
sub DeleteInputFiles($)
802
{
803
    my ($self) = @_;
804

805 806 807 808 809 810 811
    # Must be a real reference. 
    return -1
	if (! ref($self));

    my $guid = $self->guid();
    my $vers = $self->vers();
    
812 813
    DBQueryWarn("lock tables experiment_template_inputs as i write, ".
		"            experiment_template_inputs as j write, ".
Leigh B. Stoller's avatar
Leigh B. Stoller committed
814
		"            experiment_template_inputs write, ".
815 816 817 818 819 820 821 822 823 824 825 826 827 828
		"            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 ".
829
		    "      i.parent_vers='$vers' ".
830 831 832 833 834 835 836 837 838 839 840 841 842
		    "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 ".
843
		    "where parent_guid='$guid' and parent_vers='$vers'");
844 845 846 847 848 849 850 851
    DBQueryWarn("unlock tables");
    
    return -1
	if (! $query_result);

    return 0;
}

852
#
853
# Add a metadata record. 
854
#
855
sub NewMetadata($$$$;$)
856
{
857
    my ($self, $name, $value, $creator, $type) = @_;
858
    my $guid;
859 860
    my $version  = 1;
    my $internal = 0;
861
    my $metadata_type;
862

863
    # Must be a real reference. 
864
    return -1
865 866 867 868
	if (! ref($self));

    my $template_guid = $self->guid();
    my $template_vers = $self->vers();
869 870
    my $creator_uid   = $creator->uid();
    my $creator_dbid  = $creator->uid_idx();
871 872 873 874 875 876

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

    # Special ...
    $internal = 1
877
	if (defined($type));
878

879
    # Current set of allowed types;
880
    my @okay_types = ("tid", "template_description", "parameter_description",
881
		      "annotation", "instance_description", "run_description");
882 883 884 885 886 887 888 889 890 891 892 893 894

    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);
895 896
    # HTML entity encode; yep, plain text only.
    my $safevalue = DBQuoteSpecial(encode_entities($value));
897 898 899

    my $query_result =
	DBQueryWarn("insert into experiment_template_metadata_items set ".
900 901
		    "   guid='$guid', vers='$version', ".
		    "   uid='$creator_uid', uid_idx='$creator_dbid', ".
902
		    "   template_guid='$template_guid', ".
903
		    "   name=$safename, value=$safevalue, created=now()");
904 905 906 907 908
    return -1
	if (!$query_result);

    DBQueryWarn("insert into experiment_template_metadata set ".
		"   parent_guid='$template_guid', ".
909
		"   parent_vers='$template_vers', ".
910 911
		"   metadata_guid='$guid', ".
		"   metadata_vers='$version', ".
912
		"   metadata_type=$metadata_type, ".
913
		"   internal=$internal")
914
	or return -1;
915 916 917 918

    # Some metadata is special ...
    if (defined($type)) {
	if ($type eq "parameter_description") {
919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944
	    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;
945 946
	}
    }
947 948 949 950
    
    return 0;
}

951 952 953
#
# Lookup a metadata value by name, optionally returning guid/vers.
#
954
sub LookupMetadata($$;$$$)
955
{
956
    my ($self, $name, $pguid, $pvers, $ptype) = @_;
957 958 959 960 961 962 963 964 965 966 967

    # 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 =
968
	DBQueryWarn("select metadata_guid,metadata_vers,metadata_type ".
969 970 971 972 973 974 975 976 977 978 979 980
		    "   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);

981 982
    my ($metadata_guid, $metadata_vers, $metadata_type) =
	$query_result->fetchrow_array();
983 984 985 986
    $$pguid = $metadata_guid
	if (defined($pguid));
    $$pvers = $metadata_vers
	if (defined($pvers));
987 988
    $$ptype = $metadata_type
	if (defined($ptype));
989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007
    
    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();
1008 1009
    my $creator_uid   = $creator->uid();
    my $creator_dbid  = $creator->uid_idx();
1010 1011
    my $parent_guid;
    my $parent_vers;
1012
    my $metadata_type;
1013
    my $already_exists =
1014 1015
	$self->LookupMetadata($name,
			      \$parent_guid, \$parent_vers, \$metadata_type);
1016 1017 1018
    return -1
	if ($already_exists <= 0);

1019 1020
    my $safename  = DBQuoteSpecial($name);
    my $safevalue = DBQuoteSpecial(encode_entities($value));
1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040

    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', ".
1041 1042
		     "     template_guid='$template_guid', ".
		     "     uid='$creator_uid', uid_idx='$creator_dbid', ".
1043 1044
		     "     parent_guid='$parent_guid',".
		     "     parent_vers='$parent_vers'," .
1045
		     "     name=$safename, value=$safevalue, created=now()")) {
1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062
	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 ...
    #
1063 1064
    if (defined($metadata_type)) {
	if ($metadata_type eq "tid") {
1065
	    DBQueryWarn("update experiment_templates set tid=$safevalue ".
1066 1067 1068 1069 1070 1071
			"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
1072
	    Template::mysystem("$makegraph $template_guid");
1073 1074
	}
	elsif ($metadata_type eq "template_description") {
1075 1076
	    DBQueryWarn("update experiment_templates set ".
			"   description=$safevalue ".
1077 1078 1079 1080 1081 1082 1083 1084 1085 1086
			"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' ".
1087 1088
			"where parent_guid='$template_guid' and ".
			"      parent_vers='$template_vers' and ".
1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109
			"      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;
1110
	}
1111 1112 1113 1114 1115
    }
    return 0;
}

#
1116
# Add a formal parameter to a template.
1117
#
1118
sub NewFormalParameter($$$$$)
1119
{
1120
    my ($self, $name, $value, $description, $user) = @_;
1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144

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

1145 1146
    if (defined($description) && $description ne "") {
	$self->NewMetadata($name,
1147
			   $description, $user, "parameter_description")
1148 1149 1150
	    == 0 or return -1;
    }

1151 1152 1153
    return 0;
}

1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183
#
# 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;
}

1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217
#
# 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;
}

1218
#
1219
# Delete (all) template metadata
1220
#
1221
sub DeleteAllMetadata($)
1222
{
1223 1224 1225 1226 1227 1228 1229 1230
    my ($self) = @_;

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

    my $template_guid = $self->guid();
    my $template_vers = $self->vers();
1231 1232 1233 1234 1235

    my $query_result =
	DBQueryWarn("select metadata_guid ".
		    "    from experiment_template_metadata ".
		    "where parent_guid='$template_guid' and ".
1236
		    "      parent_vers='$template_vers'");
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 1263 1264 1265 1266 1267 1268 1269

    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 ".
1270
		"      parent_vers='$template_vers'")
1271 1272 1273 1274 1275
	or return -1;

    return 0;
}

1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317
#
# 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;
}

1318 1319 1320 1321
#
# Copy exiting template metadata to a child. This is likely to change
# since we probably want to share at some point.
#
1322
sub CopyMetadata($$$)
1323
{
1324
    my ($self, $parent, $copier) = @_;
1325 1326 1327

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

1330 1331 1332
    my $from_guid = $parent->guid();
    my $from_vers = $parent->vers();
    my $to_vers   = $self->vers();
1333 1334
    my $copier_uid  = $copier->uid();
    my $copier_dbid = $copier->uid_idx();
1335 1336 1337 1338 1339

    #
    # Copy the toplevel items.
    #
    my $query_result =
1340
	DBQueryWarn("select name,value,metadata_type,internal,i.parent_guid ".
1341 1342 1343 1344 1345
		    "  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 ".
1346
		    "      m.parent_vers='$from_vers'")
1347 1348
	or return -1;

1349
    while (my ($name,$value,$type,$internal,$hasparent) =
1350 1351
	   $query_result->fetchrow_array()) {

1352 1353
	my $guid;
	my $version = 1;
1354
	my $metadata_type = "NULL";
1355 1356
	my $parent_guid;
	my $parent_vers;
1357 1358 1359 1360
	
	$name   = DBQuoteSpecial($name);
	$value  = DBQuoteSpecial($value);

1361 1362 1363 1364
	#
	# XXX Some metadata is special ...
	#
	if (defined($type)) {
1365
	    # XXX Skip the tid and template descriptions and annotations.
1366
	    next
1367 1368 1369
		if ($type eq "tid" ||
		    $type eq "template_description" ||
		    $type eq "annotation");
1370

1371 1372 1373 1374
	    #
	    # XXX Skip parameters that were deleted or whose description
	    # was modified after being created.
	    #
1375 1376 1377 1378
	    if ($type eq "parameter_description") {
		my $param_result = 
		    DBQueryWarn("select * ".
				"   from experiment_template_parameters ".
1379 1380 1381
				"where parent_guid='$from_guid' and ".
				"      parent_vers='$to_vers' and ".
				"      name=$name");
1382 1383 1384 1385 1386 1387

		return -1
		    if (!$param_result);
		
		next
		    if (!$param_result->numrows);
1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411

		#
		# 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;
		}
1412 1413 1414 1415
	    }
	    $metadata_type = "'$type'";
	}

1416
	return -1
1417
	    if (!defined($guid) && NewGUID(\$guid) < 0);
1418 1419 1420

	DBQueryWarn("insert into experiment_template_metadata set ".
		    "   parent_guid='$from_guid', ".
1421
		    "   parent_vers='$to_vers', ".
1422 1423
		    "   metadata_guid='$guid', ".
		    "   metadata_vers='$version', ".
1424 1425
		    "   metadata_type=$metadata_type, ".
		    "   internal=$internal")
1426 1427 1428
	    or return -1;

	DBQueryWarn("insert into experiment_template_metadata_items set ".
1429 1430
		    "   guid='$guid', vers='$version', ".
		    "   uid='$copier_uid', uid_idx='$copier_dbid', ".
1431
		    "   template_guid='$from_guid', ".
1432 1433 1434
		    (! defined($parent_guid) ? "" :
		     "  parent_guid='$parent_guid',".
		     "  parent_vers='$parent_vers',") .
1435 1436 1437
		    "   name=$name, value=$value, created=now()")
	    or return -1;

1438 1439 1440 1441 1442 1443 1444 1445
	#
	# 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' ".
1446 1447 1448
			    "where parent_guid='$from_guid' and ".
			    "      parent_vers='$to_vers' and ".
			    "      name=$name")
1449 1450 1451 1452
		    or return -1
		}
	}
    }
1453 1454