Template.pm.in 93.8 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
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());
}

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

236 237
    return -1
	if (! ref($self));
Leigh B. Stoller's avatar
Leigh B. Stoller committed
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'");
Leigh B. Stoller's avatar
Leigh B. Stoller committed
245 246

    return -1
247 248 249
	if (!$query_result || !$query_result->numrows);
	
    $self->{'TEMPLATE'} = $query_result->fetchrow_hashref();
Leigh B. Stoller's avatar
Leigh B. Stoller committed
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 B. Stoller's avatar
Leigh B. 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
    # 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'");
418 419 420
    return -1
	if (! $query_result);

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

448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465
#
# 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";
466
    my $linkname = "$logdir/$prefix.${guid}-${vers}.log";
467 468 469 470

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

471 472 473 474 475 476 477 478 479 480 481 482 483
    my $logname  = `mktemp $logdir/$prefix.${guid}-${vers}.XXXXXX`;

    if ($logname =~ /^([-\@\w\.\/]+)$/) {
	$logname = $1;
    }
    else {
	return -1;
    }
	
    if (-e $linkname) {
	return -1
	    if (! unlink($linkname));
    }
484 485
    Template::mysystem("touch $logname") == 0
	    or return -1;
486 487 488 489 490 491
    
    if (! link($logname, $linkname)) {
	print STDERR "*** Cannot link $logname,$linkname: $!\n";
	return -1;
    }
    $$ppath = $linkname;
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 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581
    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();
}

582
#
583
# Template permission checks. Using the experiment access check stuff.
584
#
585 586 587
# Usage: AccessCheck($guid, $uid, $access_type)
#	 returns 0 if not allowed.
#        returns 1 if allowed.
588
#
589
sub AccessCheck($$$;$)
590
{
591
    my ($self, $guid, $user, $access_type);
592 593 594 595 596 597
    my $mintrust;
    
    #
    # If called as a method, no guid argument is provided. 
    #
    $self = shift();
598

599
    if (ref($self)) {
600
	($user, $access_type) = @_;
601 602
    }
    else {
603
	($guid, $user, $access_type) = @_;
604

605 606 607 608 609 610 611 612 613
	$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!");
    }
614

615 616 617
    #
    # Admins do whatever they want!
    #
618
    if (TBAdmin()) {
619 620
	return 1;
    }
621

622 623 624 625 626 627 628 629 630 631
    #
    # Transition to using user objects instead of uids
    #
    if (! ref($user)) {
	my $uid = MapNumericUID($user);

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

633
    #
634
    # A template may be destroyed by the creator or the project/group leader.
635 636 637 638 639 640 641 642
    #
    if ($access_type == TB_EXPT_READINFO) {
	$mintrust = PROJMEMBERTRUST_USER;
    }
    else {
	$mintrust = PROJMEMBERTRUST_LOCALROOT;
    }

643 644 645 646 647 648 649
    #
    # Map to group object.
    #
    my $group = Group->Lookup($self->gid_idx());
    return 0
	if (!defined($group));

650 651 652 653 654
    #
    # 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.
    #
655 656 657 658 659 660 661 662 663 664 665 666 667 668 669
    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;
670 671
}

672
#
673
# Return a list of all children of the given template.
674
#
675
sub Children($$)
676
{
677
    my ($self, $resultp) = @_;
678

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

683 684 685 686 687 688 689 690 691 692
    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");
693
    return -1
694
	if (!$query_result);
695

696 697 698
    while (my ($vers, $parent_vers) = $query_result->fetchrow_array()) {
	$children{$parent_vers} = []
	    if (!exists($children{$parent_vers}));
699

700 701 702 703 704 705 706 707 708 709 710 711 712 713
	# 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);
714

715 716 717 718 719 720
	# New children of kid
	unshift(@allkids, @{ $children{$kid} })
	    if (exists($children{$kid}));
    }
    # Most recent templates first.
    @kids = sort {$b <=> $a} @kids;
721

722 723 724 725 726 727 728
    # Now convert to template objects.
    foreach my $vers (@kids) {
	my $template = Template->Lookup($guid, $vers);
	return -1
	    if (! $template);
	push(@result, $template);
    }
729

730
    @$resultp = @result;
731 732 733 734
    return 0;
}

#
735 736 737 738 739
# 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($$)
740
{
741 742
    my ($self, $inputfile) = @_;
    my $input_data_idx;
743

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

748
    my $data_string = `cat $inputfile`;
749 750 751
    return -1
	if ($?);

752 753 754 755
    my $guid = $self->guid();
    my $vers = $self->vers();
    my $pid  = $self->pid();
    my $tid  = $self->tid();
756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771

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

772 773 774 775
	DBQueryWarn("lock tables experiment_template_inputs write, ".
		    "            experiment_template_input_data write")
	    or return -1;

776 777 778 779
	my $query_result =
	    DBQueryWarn("select idx from experiment_template_input_data ".
			"where md5='$md5'");

780 781 782 783
	if (!$query_result) {
	    DBQueryWarn("unlock tables");
	    return -1;
	}
784 785

	if ($query_result->numrows) {
786
	    ($input_data_idx) = $query_result->fetchrow_array();
787 788 789 790 791 792 793
	}
	else {
	    $query_result =
		DBQueryWarn("insert into experiment_template_input_data ".
			    "(idx, md5, input) ".
			    "values (NULL, '$md5', $data_string)");
	    
794 795 796 797 798
	    if (!$query_result) {
		DBQueryWarn("unlock tables");
		return -1;
	    }
	    $input_data_idx = $query_result->insertid;
799 800
	}

801 802 803 804
	$query_result =
	    DBQueryWarn("insert into experiment_template_inputs ".
			" (idx, parent_guid, parent_vers, ".
			"  pid, tid, input_idx) values ".
805
			" (NULL, '$guid', '$vers', '$pid', '$tid', ".
806 807
			"  '$input_data_idx')");
	DBQueryWarn("unlock tables");
808
	return -1
809
	    if (!$query_result);
810 811 812 813
    }
    return 0;
}

814
#
815
# Delete all input files, say for a template create/modify that fails.
816
#
817
sub DeleteInputFiles($)
818
{
819
    my ($self) = @_;
820

821 822 823 824 825 826 827
    # Must be a real reference. 
    return -1
	if (! ref($self));

    my $guid = $self->guid();
    my $vers = $self->vers();
    
828 829
    DBQueryWarn("lock tables experiment_template_inputs as i write, ".
		"            experiment_template_inputs as j write, ".
Leigh B. Stoller's avatar
Leigh B. Stoller committed
830
		"            experiment_template_inputs write, ".
831 832 833 834 835 836 837 838 839 840 841 842 843 844
		"            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 ".
845
		    "      i.parent_vers='$vers' ".
846 847 848 849 850 851 852 853 854 855 856 857 858
		    "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 ".
859
		    "where parent_guid='$guid' and parent_vers='$vers'");
860 861 862 863 864 865 866 867
    DBQueryWarn("unlock tables");
    
    return -1
	if (! $query_result);

    return 0;
}

868
#
869
# Add a metadata record. 
870
#
871
sub NewMetadata($$$$;$)
872
{
873
    my ($self, $name, $value, $creator, $type) = @_;
874
    my $guid;
875 876
    my $version  = 1;
    my $internal = 0;
877
    my $metadata_type;
878

879
    # Must be a real reference. 
880
    return -1
881 882 883 884
	if (! ref($self));

    my $template_guid = $self->guid();
    my $template_vers = $self->vers();
885 886
    my $creator_uid   = $creator->uid();
    my $creator_dbid  = $creator->uid_idx();
887 888 889 890 891 892

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

    # Special ...
    $internal = 1
893
	if (defined($type));
894

895
    # Current set of allowed types;
896
    my @okay_types = ("tid", "template_description", "parameter_description",
897
		      "annotation", "instance_description", "run_description");
898 899 900 901 902 903 904 905 906 907 908 909 910

    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);
911 912
    # HTML entity encode; yep, plain text only.
    my $safevalue = DBQuoteSpecial(encode_entities($value));
913 914 915

    my $query_result =
	DBQueryWarn("insert into experiment_template_metadata_items set ".
916 917
		    "   guid='$guid', vers='$version', ".
		    "   uid='$creator_uid', uid_idx='$creator_dbid', ".
918
		    "   template_guid='$template_guid', ".
919
		    "   name=$safename, value=$safevalue, created=now()");
920 921 922 923 924
    return -1
	if (!$query_result);

    DBQueryWarn("insert into experiment_template_metadata set ".
		"   parent_guid='$template_guid', ".
925
		"   parent_vers='$template_vers', ".
926 927
		"   metadata_guid='$guid', ".
		"   metadata_vers='$version', ".
928
		"   metadata_type=$metadata_type, ".
929
		"   internal=$internal")
930
	or return -1;
931 932 933 934

    # Some metadata is special ...
    if (defined($type)) {
	if ($type eq "parameter_description") {
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
	    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;
961 962
	}
    }
963 964 965 966
    
    return 0;
}

967 968 969
#
# Lookup a metadata value by name, optionally returning guid/vers.
#
970
sub LookupMetadata($$;$$$)
971
{
972
    my ($self, $name, $pguid, $pvers, $ptype) = @_;
973 974 975 976 977 978 979 980 981 982 983

    # 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 =
984
	DBQueryWarn("select metadata_guid,metadata_vers,metadata_type ".
985 986 987 988 989 990 991 992 993 994 995 996
		    "   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);

997 998
    my ($metadata_guid, $metadata_vers, $metadata_type) =
	$query_result->fetchrow_array();
999 1000 1001 1002
    $$pguid = $metadata_guid
	if (defined($pguid));
    $$pvers = $metadata_vers
	if (defined($pvers));
1003 1004
    $$ptype = $metadata_type
	if (defined($ptype));
1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023
    
    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();
1024 1025
    my $creator_uid   = $creator->uid();
    my $creator_dbid  = $creator->uid_idx();
1026 1027
    my $parent_guid;
    my $parent_vers;
1028
    my $metadata_type;
1029
    my $already_exists =
1030 1031
	$self->LookupMetadata($name,
			      \$parent_guid, \$parent_vers, \$metadata_type);
1032 1033 1034
    return -1
	if ($already_exists <= 0);

1035 1036
    my $safename  = DBQuoteSpecial($name);
    my $safevalue = DBQuoteSpecial(encode_entities($value));
1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056

    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', ".
1057 1058
		     "     template_guid='$template_guid', ".
		     "     uid='$creator_uid', uid_idx='$creator_dbid', ".
1059 1060
		     "     parent_guid='$parent_guid',".
		     "     parent_vers='$parent_vers'," .
1061
		     "     name=$safename, value=$safevalue, created=now()")) {
1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078
	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 ...
    #
1079 1080
    if (defined($metadata_type)) {
	if ($metadata_type eq "tid") {
1081
	    DBQueryWarn("update experiment_templates set tid=$safevalue ".
1082 1083 1084 1085 1086 1087
			"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
1088
	    Template::mysystem("$makegraph $template_guid");
1089 1090
	}
	elsif ($metadata_type eq "template_description") {
1091 1092
	    DBQueryWarn("update experiment_templates set ".
			"   description=$safevalue ".
1093 1094 1095 1096 1097 1098 1099 1100 1101 1102
			"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' ".
1103 1104
			"where parent_guid='$template_guid' and ".
			"      parent_vers='$template_vers' and ".
1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125
			"      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;
1126
	}
1127 1128 1129 1130 1131
    }
    return 0;
}

#
1132
# Add a formal parameter to a template.
1133
#
1134
sub NewFormalParameter($$$$$)
1135
{
1136
    my ($self, $name, $value, $description, $user) = @_;
1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160

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

1161 1162
    if (defined($description) && $description ne "") {
	$self->NewMetadata($name,
1163
			   $description, $user, "parameter_description")
1164 1165 1166
	    == 0 or return -1;
    }

1167 1168 1169
    return 0;
}

1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199
#
# 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;
}

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 1229 1230 1231 1232 1233
#
# 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;
}

1234
#
1235
# Delete (all) template metadata
1236
#
1237
sub DeleteAllMetadata($)
1238
{
1239 1240 1241 1242 1243 1244 1245 1246
    my ($self) = @_;

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

    my $template_guid = $self->guid();
    my $template_vers = $self->vers();
1247 1248 1249 1250 1251

    my $query_result =
	DBQueryWarn("select metadata_guid ".
		    "    from experiment_template_metadata ".
		    "where parent_guid='$template_guid' and ".
1252
		    "      parent_vers='$template_vers'");
1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285

    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 ".
1286
		"      parent_vers='$template_vers'")
1287 1288 1289 1290 1291
	or return -1;

    return 0;
}

1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333
#
# 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;
}

1334 1335 1336 1337
#
# Copy exiting template metadata to a child. This is likely to change
# since we probably want to share at some point.
#
1338
sub CopyMetadata($$$)
1339
{
1340
    my ($self, $parent, $copier) = @_;
1341 1342 1343

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

1346 1347 1348
    my $from_guid = $parent->guid();
    my $from_vers = $parent->vers();
    my $to_vers   = $self->vers();
1349 1350
    my $copier_uid  = $copier->uid();
    my $copier_dbid = $copier->uid_idx();
1351 1352 1353 1354 1355

    #
    # Copy the toplevel items.
    #
    my $query_result =
1356
	DBQueryWarn("select name,value,metadata_type,internal,i.parent_guid ".
1357 1358 1359 1360 1361
		    "  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 ".
1362
		    "      m.parent_vers='$from_vers'")
1363 1364
	or return -1;

1365
    while (my ($name,$value,$type,$internal,$hasparent) =
1366 1367
	   $query_result->fetchrow_array()) {

1368 1369
	my $guid;
	my $version = 1;
1370
	my $metadata_type = "NULL";
1371 1372
	my $parent_guid;
	my $parent_vers;
1373 1374 1375 1376
	
	$name   = DBQuoteSpecial($name);
	$value  = DBQuoteSpecial($value);

1377 1378 1379 1380
	#
	# XXX Some metadata is special ...
	#
	if (defined($type)) {
1381
	    # XXX Skip the tid and template descriptions and annotations.
1382
	    next
1383 1384 1385
		if ($type eq "tid" ||
		    $type eq "template_description" ||
		    $type eq "annotation");
1386

1387 1388 1389 1390
	    #
	    # XXX Skip parameters that were deleted or whose description
	    # was modified after being created.
	    #
1391 1392 1393 1394
	    if ($type eq "parameter_description") {
		my $param_result = 
		    DBQueryWarn("select * ".
				"   from experiment_template_parameters ".
1395 1396 1397
				"where parent_guid='$from_guid' and ".
				"      parent_vers='$to_vers' and ".
				"      name=$name");
1398 1399 1400 1401 1402 1403

		return -1
		    if (!$param_result);
		
		next
		    if (!$param_result->numrows);
1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427

		#
		# 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;
		}
1428 1429 1430 1431
	    }
	    $metadata_type = "'$type'";
	}

1432
	return -1
1433
	    if (!defined($guid) && NewGUID(\$guid) < 0);
1434 1435 1436

	DBQueryWarn("insert into experiment_template_metadata set ".
		    "   parent_guid='$from_guid', ".
1437
		    "   parent_vers='$to_vers', ".
1438 1439
		    "   metadata_guid='$guid', ".
		    "   metadata_vers='$version', ".
1440 1441
		    "   metadata_type=$metadata_type, ".
		    "   internal=$internal")
1442 1443 1444
	    or return -1;

	DBQueryWarn("insert into experiment_template_metadata_items set ".
1445 1446
		    "   guid='$guid', vers='$version', ".
		    "   uid='$copier_uid', uid_idx='$copier_dbid', ".