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

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

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

# Must come after package declaration!
use lib '@prefix@/lib';
use libdb;
use libtestbed;
use libtblog;
23
use Experiment;
24
use English;
25
use overload ('""' => 'Stringify');
26 27 28

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

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

43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76
#
# 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
77 78 79 80 81 82 83 84 85 86
# Little helper and debug function.
sub mysystem($)
{
    my ($command) = @_;

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

87
#
88
# Lookup a template and create a class instance to return.
89
#
90
sub Lookup($$$)
91
{
92
    my ($class, $guid, $vers) = @_;
93

94 95 96 97
    # Look in cache first
    return $templates{"$guid/$vers"}
        if (exists($templates{"$guid/$vers"}));
    
98
    my $query_result =
99 100
	DBQueryWarn("select * from experiment_templates ".
		    "where guid='$guid' and vers='$vers'");
101

102 103
    return undef
	if (!$query_result || !$query_result->numrows);
104

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

#
138
# Lookup a template given an experiment index.
139
#
140
sub LookupByExptidx($$)
141
{
142
    my ($class, $exptidx) = @_;
143

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

147 148
    return undef
	if (!defined($template_instance));
149

150
    return $template_instance->template();
151 152
}

153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172
#
# Lookup a template given pid,eid. This refers to the template itself,
# not an instance of the template.
#
sub LookupByPidEid($$$)
{
    my ($class, $pid, $eid) = @_;

    my $query_result =
	DBQueryWarn("select guid,vers from experiment_templates ".
		    "where pid='$pid' and eid='$eid'");

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

    my ($guid,$vers) = $query_result->fetchrow_array();

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

Leigh B. Stoller's avatar
Leigh B. Stoller committed
173
#
174
# Refresh a template instance by reloading from the DB.
Leigh B. Stoller's avatar
Leigh B. Stoller committed
175
#
176
sub Refresh($)
Leigh B. Stoller's avatar
Leigh B. Stoller committed
177
{
178
    my ($self) = @_;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
179

180 181
    return -1
	if (! ref($self));
Leigh B. Stoller's avatar
Leigh B. Stoller committed
182

183 184 185 186 187 188
    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
189 190

    return -1
191 192 193
	if (!$query_result || !$query_result->numrows);
	
    $self->{'TEMPLATE'} = $query_result->fetchrow_hashref();
Leigh B. Stoller's avatar
Leigh B. Stoller committed
194 195 196
    return 0;
}

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

206 207
    return undef
	if (ref($class));
208

209 210 211 212 213 214 215 216 217 218 219 220 221
    # 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;
222 223
    }

224 225 226
    DBQueryWarn("lock tables experiments write, ".
		"            experiment_templates write")
	or return undef;
227

228 229 230 231 232 233 234
    #
    # 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'");
235

236 237 238 239
	if (!$query_result) {
	    DBQueryWarn("unlock tables");
	    return undef;
	}
240

241 242 243
	$vers = ($query_result->fetchrow_array())[0];
	$vers++;
    }
244

245 246 247 248
    # We make up an eid using the guid and version. This is the eid for the
    # hidden experiment behind each template. 
    my $eid = "T${guid}-${vers}";
    my $pid = $argref->{'pid'};
249

250
    #
251
    # Sanity check; make sure this eid is not in use. Tables are still locked.
252 253
    #
    my $query_result =
254 255
	DBQueryWarn("select pid,eid from experiments ".
		    "where eid='$eid' and pid='$pid'");
256

257 258 259 260 261 262 263 264 265
    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;
266 267
    }

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

271 272
    # Append the rest
    $query .= ",created=now(),guid='$guid',vers='$vers',eid='$eid'";
273

274 275 276 277 278 279 280
    if (! DBQueryWarn($query)) {
	DBQueryWarn("unlock tables");
	return undef;
    }
    DBQueryWarn("unlock tables");

    return Template->Lookup($guid, $vers);
281 282 283
}

#
284
# Stringify for output.
285
#
286
sub Stringify($)
287
{
288 289 290
    my ($self) = @_;
    my $guid   = $self->guid();
    my $vers   = $self->vers();
291

292
    return "[Template: $guid/$vers]";
293 294
}

295
#
296
# Update a template record given an array reference of slot/value pairs.
297
#
298
sub Update($$)
299
{
300
    my ($self, $argref) = @_;
301

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

306 307
    my $guid = $self->guid();
    my $vers = $self->vers();
308

309 310 311 312
    my $query = "update experiment_templates set ".
	join(",", map("$_='" . $argref->{$_} . "'", keys(%{$argref})));

    $query .= " where guid='$guid' and vers='$vers'";
313 314 315

    return -1
	if (! DBQueryWarn($query));
316 317

    return Refresh($self);
318 319
}

320
#
321 322
# Delete a template (all tables). Note that other parts of the template
# like instances must already be gone when this is called.
323
#
324
sub Delete($)
325
{
326
    my ($self) = @_;
327

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

332 333
    my $guid = $self->guid();
    my $vers = $self->vers();
334 335 336 337 338 339
    my $path = $self->path();

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

341
    DeleteAllMetadata($self) == 0
342
	or return -1;
343

344 345
    DeleteInputFiles($self) == 0
	or return -1;
346

347 348 349 350
    # 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'");
351 352 353
    return -1
	if (! $query_result);

354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377
    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;
378 379 380
    return 0;
}

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

398 399 400 401 402
    if (ref($self)) {
	($uid, $access_type) = @_;
    }
    else {
	($guid, $uid, $access_type) = @_;
403

404 405 406 407 408 409 410 411 412
	$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!");
    }
413

414 415 416 417 418 419 420
    #
    # Admins do whatever they want!
    #
    if (TBAdmin($uid)) {
	return 1;
    }
    $uid = MapNumericUID($uid);
421

422 423
    my $pid = $self->pid();
    my $gid = $self->gid();
424

425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442
    #
    # An experiment may be destroyed by the experiment creator or the
    # project/group leader.
    #
    if ($access_type == TB_EXPT_READINFO) {
	$mintrust = PROJMEMBERTRUST_USER;
    }
    else {
	$mintrust = PROJMEMBERTRUST_LOCALROOT;
    }

    #
    # Either proper permission in the group, or group_root in the project.
    # This lets group_roots muck with other people's experiments, including
    # those in groups they do not belong to.
    #
    return TBMinTrust(TBGrpTrust($uid, $pid, $gid), $mintrust) ||
	TBMinTrust(TBGrpTrust($uid, $pid, $pid), PROJMEMBERTRUST_GROUPROOT);
443 444
}

445
#
446
# Return a list of all children of the given template.
447
#
448
sub Children($$)
449
{
450
    my ($self, $resultp) = @_;
451

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

456 457 458 459 460 461 462 463 464 465
    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");
466
    return -1
467
	if (!$query_result);
468

469 470 471
    while (my ($vers, $parent_vers) = $query_result->fetchrow_array()) {
	$children{$parent_vers} = []
	    if (!exists($children{$parent_vers}));
472

473 474 475 476 477 478 479 480 481 482 483 484 485 486
	# 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);
487

488 489 490 491 492 493
	# New children of kid
	unshift(@allkids, @{ $children{$kid} })
	    if (exists($children{$kid}));
    }
    # Most recent templates first.
    @kids = sort {$b <=> $a} @kids;
494

495 496 497 498 499 500 501
    # Now convert to template objects.
    foreach my $vers (@kids) {
	my $template = Template->Lookup($guid, $vers);
	return -1
	    if (! $template);
	push(@result, $template);
    }
502

503
    @$resultp = @result;
504 505 506 507
    return 0;
}

#
508 509 510 511 512
# 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($$)
513
{
514 515
    my ($self, $inputfile) = @_;
    my $input_data_idx;
516

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

521
    my $data_string = `cat $inputfile`;
522 523 524
    return -1
	if ($?);

525 526 527 528
    my $guid = $self->guid();
    my $vers = $self->vers();
    my $pid  = $self->pid();
    my $tid  = $self->tid();
529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544

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

545 546 547 548
	DBQueryWarn("lock tables experiment_template_inputs write, ".
		    "            experiment_template_input_data write")
	    or return -1;

549 550 551 552
	my $query_result =
	    DBQueryWarn("select idx from experiment_template_input_data ".
			"where md5='$md5'");

553 554 555 556
	if (!$query_result) {
	    DBQueryWarn("unlock tables");
	    return -1;
	}
557 558

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

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

587
#
588
# Delete all input files, say for a template create/modify that fails.
589
#
590
sub DeleteInputFiles($)
591
{
592
    my ($self) = @_;
593

594 595 596 597 598 599 600
    # Must be a real reference. 
    return -1
	if (! ref($self));

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

    return 0;
}

641
#
642
# Add a metadata record. 
643
#
644
sub NewMetadata($$$$;$)
645
{
646
    my ($self, $name, $value, $creator, $type) = @_;
647
    my $guid;
648 649
    my $version  = 1;
    my $internal = 0;
650
    my $metadata_type;
651

652
    # Must be a real reference. 
653
    return -1
654 655 656 657 658 659 660 661 662 663
	if (! ref($self));

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

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

    # Special ...
    $internal = 1
664
	if (defined($type));
665

666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681
    # Current set of allowed types;
    my @okay_types = ("tid", "template_description", "parameter_description");

    if (defined($type)) {
	if (! grep {$_ eq $type} @okay_types) {
	    tberror("Illegal metadata type: $type");
	    return -1;
	}
	$metadata_type = "'$type'";
    }
    else {
	$metadata_type = "NULL";
    }

    my $safename  = DBQuoteSpecial($name);
    my $safevalue = DBQuoteSpecial($value);
682 683 684

    my $query_result =
	DBQueryWarn("insert into experiment_template_metadata_items set ".
685
		    "   guid='$guid', vers='$version', uid='$creator', ".
686
		    "   template_guid='$template_guid', ".
687
		    "   name=$safename, value=$safevalue, created=now()");
688 689 690 691 692
    return -1
	if (!$query_result);

    DBQueryWarn("insert into experiment_template_metadata set ".
		"   parent_guid='$template_guid', ".
693
		"   parent_vers='$template_vers', ".
694 695
		"   metadata_guid='$guid', ".
		"   metadata_vers='$version', ".
696
		"   metadata_type=$metadata_type, ".
697
		"   internal=$internal")
698
	or return -1;
699 700 701 702 703 704 705 706

    # Some metadata is special ...
    if (defined($type)) {
	if ($type eq "parameter_description") {
	    $query_result =
		DBQueryWarn("update experiment_template_parameters set ".
			    "   metadata_guid='$guid', ".
			    "   metadata_vers='$version' ".
707 708 709
			    "where parent_guid='$template_guid' and ".
			    "      parent_vers='$template_vers' and ".
			    "      name=$safename");
710 711 712 713
	    return -1
		if (!$query_result);
	}
    }
714 715 716 717
    
    return 0;
}

718 719 720
#
# Lookup a metadata value by name, optionally returning guid/vers.
#
721
sub LookupMetadata($$;$$$)
722
{
723
    my ($self, $name, $pguid, $pvers, $ptype) = @_;
724 725 726 727 728 729 730 731 732 733 734

    # 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 =
735
	DBQueryWarn("select metadata_guid,metadata_vers,metadata_type ".
736 737 738 739 740 741 742 743 744 745 746 747
		    "   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);

748 749
    my ($metadata_guid, $metadata_vers, $metadata_type) =
	$query_result->fetchrow_array();
750 751 752 753
    $$pguid = $metadata_guid
	if (defined($pguid));
    $$pvers = $metadata_vers
	if (defined($pvers));
754 755
    $$ptype = $metadata_type
	if (defined($ptype));
756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776
    
    return 1;
}

#
# Modify a metadata record; these are versioned of course.
#
sub ModifyMetadata($$$$)
{
    my ($self, $name, $value, $creator) = @_;
    my $guid;
    my $version = 1;

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

    my $template_guid = $self->guid();
    my $template_vers = $self->vers();
    my $parent_guid;
    my $parent_vers;
777
    my $metadata_type;
778
    my $already_exists =
779 780
	$self->LookupMetadata($name,
			      \$parent_guid, \$parent_vers, \$metadata_type);
781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826
    return -1
	if ($already_exists <= 0);

    $name  = DBQuoteSpecial($name);
    $value = DBQuoteSpecial($value);

    DBQueryWarn("lock tables experiment_template_metadata_items write")
	or return -1;
    
    my $query_result =
	DBQueryWarn("select MAX(vers) ".
		    " from experiment_template_metadata_items ".
		    "where guid='$parent_guid'");
    if (!$query_result) {
	DBQueryWarn("unlock tables");
	return -1;
    }
    my ($metadata_vers) = $query_result->fetchrow_array();
    $metadata_vers++;

    #
    # Insert new item.
    #
    if (!DBQueryWarn("insert into experiment_template_metadata_items set ".
		     "     guid='$parent_guid',vers='$metadata_vers', ".
		     "     template_guid='$template_guid', uid='$creator', ".
		     "     parent_guid='$parent_guid',".
		     "     parent_vers='$parent_vers'," .
		     "     name=$name, value=$value, created=now()")) {
	DBQueryWarn("unlock tables");
	return -1;
    }
    DBQueryWarn("unlock tables");

    if (!DBQueryWarn("update experiment_template_metadata ".
		     "  set metadata_vers='$metadata_vers' ".
		     "where metadata_guid='$parent_guid' and ".
		     "      metadata_vers='$parent_vers'")) {
	DBQueryWarn("delete from experiment_template_metadata_items ".
		    "where guid='$parent_guid',vers='$metadata_vers'");
	return -1;
    }

    #
    # XXX Some metadata is special ...
    #
827 828 829 830 831 832 833 834 835
    if (defined($metadata_type)) {
	if ($metadata_type eq "tid") {
	    DBQueryWarn("update experiment_templates set tid=$value ".
			"where guid='$template_guid' and ".
			"      vers='$template_vers'")
		or return -1;
	    
	    Refresh($self);
	    # This can fail; it is not critical.
Leigh B. Stoller's avatar
Leigh B. Stoller committed
836
	    Template::mysystem("$makegraph $template_guid");
837 838 839 840 841 842 843 844 845 846 847 848 849
	}
	elsif ($metadata_type eq "template_description") {
	    DBQueryWarn("update experiment_templates set description=$value ".
			"where guid='$template_guid' and ".
			"      vers='$template_vers'")
		or return -1;
	    
	    Refresh($self);	
	}
	elsif ($metadata_type eq "parameter_description") {
	    DBQueryWarn("update experiment_template_parameters set ".
			"   metadata_guid='$parent_guid', ".
			"   metadata_vers='$metadata_vers' ".
850 851 852
			"where parent_guid='$template_guid' and ".
			"      parent_vers='$template_vers' and ".
			"      name=$name")
853 854
		or return -1
	}
855 856 857 858 859
    }
    return 0;
}

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

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

889 890 891 892 893 894
    if (defined($description) && $description ne "") {
	$self->NewMetadata($name,
			   $description, $dbuid, "parameter_description")
	    == 0 or return -1;
    }

895 896 897
    return 0;
}

898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927
#
# 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;
}

928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961
#
# 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;
}

962
#
963
# Delete (all) template metadata
964
#
965
sub DeleteAllMetadata($)
966
{
967 968 969 970 971 972 973 974
    my ($self) = @_;

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

    my $template_guid = $self->guid();
    my $template_vers = $self->vers();
975 976 977 978 979

    my $query_result =
	DBQueryWarn("select metadata_guid ".
		    "    from experiment_template_metadata ".
		    "where parent_guid='$template_guid' and ".
980
		    "      parent_vers='$template_vers'");
981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013

    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 ".
1014
		"      parent_vers='$template_vers'")
1015 1016 1017 1018 1019
	or return -1;

    return 0;
}

1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061
#
# 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;
}

1062 1063 1064 1065
#
# Copy exiting template metadata to a child. This is likely to change
# since we probably want to share at some point.
#
1066
sub CopyMetadata($$$)
1067
{
1068
    my ($self, $parent, $copier) = @_;
1069 1070 1071

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

1074 1075 1076
    my $from_guid = $parent->guid();
    my $from_vers = $parent->vers();
    my $to_vers   = $self->vers();
1077 1078 1079 1080 1081

    #
    # Copy the toplevel items.
    #
    my $query_result =
1082
	DBQueryWarn("select name,value,metadata_type,internal,i.parent_guid ".
1083 1084 1085 1086 1087
		    "  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 ".
1088
		    "      m.parent_vers='$from_vers'")
1089 1090
	or return -1;

1091
    while (my ($name,$value,$type,$internal,$hasparent) =
1092 1093
	   $query_result->fetchrow_array()) {

1094 1095
	my $guid;
	my $version = 1;
1096
	my $metadata_type = "NULL";
1097 1098
	my $parent_guid;
	my $parent_vers;
1099 1100 1101 1102
	
	$name   = DBQuoteSpecial($name);
	$value  = DBQuoteSpecial($value);

1103 1104 1105 1106 1107 1108 1109 1110
	#
	# XXX Some metadata is special ...
	#
	if (defined($type)) {
	    # XXX Skip the tid and template descriptions.
	    next
		if ($type eq "tid" or $type eq "template_description");

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

		return -1
		    if (!$param_result);
		
		next
		    if (!$param_result->numrows);
1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151

		#
		# 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;
		}
1152 1153 1154 1155
	    }
	    $metadata_type = "'$type'";
	}

1156
	return -1
1157
	    if (!defined($guid) && NewGUID(\$guid) < 0);
1158 1159 1160

	DBQueryWarn("insert into experiment_template_metadata set ".
		    "   parent_guid='$from_guid', ".
1161
		    "   parent_vers='$to_vers', ".
1162 1163
		    "   metadata_guid='$guid', ".
		    "   metadata_vers='$version', ".
1164 1165
		    "   metadata_type=$metadata_type, ".
		    "   internal=$internal")
1166 1167 1168
	    or return -1;

	DBQueryWarn("insert into experiment_template_metadata_items set ".
1169
		    "   guid='$guid', vers='$version', uid='$copier', ".
1170
		    "   template_guid='$from_guid', ".
1171 1172 1173
		    (! defined($parent_guid) ? "" :
		     "  parent_guid='$parent_guid',".
		     "  parent_vers='$parent_vers',") .
1174 1175 1176
		    "   name=$name, value=$value, created=now()")
	    or return -1;

1177 1178 1179 1180 1181 1182 1183 1184
	#
	# 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' ".
1185 1186 1187
			    "where parent_guid='$from_guid' and ".
			    "      parent_vers='$to_vers' and ".
			    "      name=$name")
1188 1189 1190 1191
		    or return -1
		}
	}
    }
1192 1193 1194
    return 0;
}

1195 1196 1197 1198 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 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239
#
# 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;
}

1240
#
1241
# Create a new Instance record, using the package below.
1242
#
1243
sub NewInstance($$$)
1244
{
1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261
    my ($self, $eid, $creator) = @_;

    # 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;
    $args{'uid'}         = $creator;

    return Template::Instance->Create(\%args);
}

1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285
#
# 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;
}

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 1318 1319
#
# 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);
1320
    
1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336
    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;
}

1337 1338 1339
#
# Copy the datastore from parent template to child template.
#
1340
sub CopyDataStore($$)
1341 1342 1343 1344 1345 1346 1347 1348 1349 1350
{
    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 B. Stoller's avatar
Leigh B. Stoller committed
1351 1352
    Template::mysystem("cd $from_path; ".
		       "   $RSYNC -rtgoDlz datastore $to_path") == 0
1353 1354 1355 1356 1357
	or return -1;

    return 0;
}

1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377
#
# Import datastore from a directory back into the template. Currently
# used when creating a template from an instance.
#
sub ImportDataStore($$)
{
    my ($self, $from_path) = @_;

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

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

    Template::mysystem("$RSYNC -rtgoDlz ${from_path}/ $to_path/datastore") == 0
	or return -1;

    return 0;
}

1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441
#
# Hide Template, optionally hiding all children.
#
sub Hide($$)
{
    my ($self, $recursive) = @_;

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

    my $guid = $self->guid();
    my $vers = $self->vers();
    
    DBQueryWarn("update experiment_templates set hidden=1 ".
		"where guid='$guid' and ".
		"      vers='$vers'")
	or return -1;
    
    Refresh($self) == 0
	or return -1;

    if ($recursive) {
	$self->Recurse("hidden=1") == 0
	    or return -1;
    }
    # This can fail; it is not critical.
    Template::mysystem("$makegraph $guid");
    
    return 0;
}

#
# Show Template, optionally showing all children.
#
sub Show($$)
{
    my ($self, $recursive) = @_;

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

    my $guid = $self->guid();
    my $vers = $self->vers();
    
    DBQueryWarn("update experiment_templates set hidden=0 ".
		"where guid='$guid' and ".
		"      vers='$vers'")
	or return -1;
    
    Refresh($self) == 0
	or return -1;

    if ($recursive) {
	$self->Recurse("hidden=0") == 0
	    or return -1;
    }
    # This can fail; it is not critical.
    Template::mysystem("$makegraph $guid");
    
    return 0;
}

Leigh B. Stoller's avatar
Leigh B. Stoller committed
1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489
#
# Activate/InActivate a template. What is an active template? Its one the
# user is futzing with and wants at the top of the list. Inactive templates
# are there but not considered important.
#
sub Activate($)
{
    my ($self) = @_;

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

    my $guid = $self->guid();
    my $vers = $self->vers();
    
    DBQueryWarn("update experiment_templates set active=1 ".
		"where guid='$guid' and ".
		"      vers='$vers'")
	or return -1;
    
    Refresh($self) == 0
	or return -1;

    return 0;
}
sub InActivate($)
{
    my ($self) = @_;

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

    my $guid = $self->guid();
    my $vers = $self->vers();
    
    DBQueryWarn("update experiment_templates set active=0 ".
		"where guid='$guid' and ".
		"      vers='$vers'")
	or return -1;
    
    Refresh($self) == 0
	or return -1;

    return 0;
}

1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519
# Improve this at some point.
sub Recurse($$)
{
    my ($self, $string) = @_;
    my %children = ();

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

    my $template_guid = $self->guid();
    my $template_vers = $self->vers();
    
    my $query_result =
	DBQueryWarn("select vers,parent_vers from experiment_templates ".
		    "where guid='$template_guid' ".
		    "order by vers");
    return -1
	if (!$query_result);

    # Build up lists of childen.
    while (my ($vers,$parent_vers) = $query_result->fetchrow_array()) {
	next
	    if (!defined($parent_vers));

	$children{$parent_vers} = []
	    if (!exists($children{$parent_vers}));
	push(@{ $children{$parent_vers} }, $vers);
    }

Leigh B. Stoller's avatar
Leigh B. Stoller committed
1520 1521 1522 1523
    # A leaf node ...
    return 0
	if (!exists($children{$template_vers}));

1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539
    # Recurse through all the children of this template.
    my @kids = @{ $children{$template_vers} };

    while (@kids) {
	my $kid     = shift(@kids);

	DBQueryWarn("update experiment_templates set $string ".
		    "where guid='$template_guid' and vers='$kid'")
	    or return -1;

	push(@kids, @{ $children{$kid} })
	    if (exists($children{$kid}));
    }
    return 0;
}

1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595
#
# Create directory for template.
#
sub CreateDirectory($)
{
    my ($self) = @_;

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

    my $guid = $self->guid();
    my $vers = $self->vers();
    my $pid  = $self->pid();
    my $eid  = $self->eid();
    my $gid  = $self->gid();
    my $rval = 0;
    
    my $projroot = PROJROOT();
    my $guiddir  = "$projroot/$pid/templates/$guid";
    my $versdir  = "$guiddir/$vers";

    DBQueryWarn("update experiment_templates set ".
		"  path='$versdir' ".
		"where guid='$guid' and vers='$vers'")
	or return -1;

    # Or else the caller does not see the above change!
    Refresh($self) == 0
	or return -1;

    my $unix_gid;
    my $unix_name;
    
    if (! TBGroupUnixInfo($pid, $gid, \$unix_gid, \$unix_name)) {
	print "*** No info for project/group $pid/$gid!\n";
	return -1;
    }
    if (! -e $guiddir) {
	if (! mkdir($guiddir, 0770) ||
	    ! chmod(0770, "$guiddir") ||
	    ! chown($UID, $unix_gid, "$guiddir")) {
	    $rval = $ERRNO;
	    print "*** Could not create directory $guiddir: $!\n";
	    mysystem("$RMDIR $guiddir")
		if (-e $guiddir);
	    return $rval;
	}
    }
    if (! mkdir($versdir, 0775) ||
	! chmod(0775, "$versdir") ||
	! chown($UID, $unix_gid, "$versdir")) {
	$rval = $ERRNO;
	print "*** Could not create directory $versdir: $!\n";
	return $rval;
    }
1596
    foreach my $token ("tbdata", "archive", "datastore", "logs") {
1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624
	my $dir = "$versdir/$token";
	
	if (! mkdir($dir, 0770) ||
	    ! chmod(0770, "$dir")) {
	    $rval = $ERRNO;
	    print "*** Could not create directory $dir: $!\n";
	    return $rval;
	}
    }

    my $workdir = TBExptWorkDir($pid, $eid);

    #
    # We need this cause a template has an experiment sitting underneath it.
    #
    if (-e $workdir) {
	print "*** $workdir already exists!\n";
	return -1;
    }
    if (! mkdir($workdir, 0775) ||
	! chown($UID, $unix_gid, "$workdir")) {
	print "*** Could not create $workdir: $!\n";
	return -1;
    }
    
    return 0;
}

1625 1626 1627 1628 1629 1630 1631
############################################################################

package Template::Instance;
use libdb;
use libtestbed;
use libtblog;
use English;
1632
use libArchive;
1633 1634 1635 1636 1637 1638 1639 1640 1641
use overload ('""' => 'Stringify');

#
# Lookup a template experiment and create a class instance to return.
#
sub LookupByID($$)
{
    my ($class, $idx) = @_;

1642
    my $query_result =
1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659
	DBQueryWarn("select * ".
		    "  from experiment_template_instances ".
		    "where idx='$idx'");

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

    my $self            = {};
    $self->{'DB'}       = $query_result->fetchrow_hashref();

    # Backlink to the template.
    my $template_guid   = $self->{'DB'}->{'parent_guid'};
    my $template_vers   = $self->{'DB'}->{'parent_vers'};
    my $template        = Template->Lookup($template_guid, $template_vers);
    return undef
	if (!defined($template));
    $self->{'TEMPLATE'} = $template;
1660

1661 1662