Image.pm.in 52 KB
Newer Older
1 2
#!/usr/bin/perl -wT
#
3
# Copyright (c) 2007-2015 University of Utah and the Flux Group.
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
# 
# {{{EMULAB-LICENSE
# 
# This file is part of the Emulab network testbed software.
# 
# This file is free software: you can redistribute it and/or modify it
# under the terms of the GNU Affero General Public License as published by
# the Free Software Foundation, either version 3 of the License, or (at
# your option) any later version.
# 
# This file is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public
# License for more details.
# 
# You should have received a copy of the GNU Affero General Public License
# along with this file.  If not, see <http://www.gnu.org/licenses/>.
# 
# }}}
23 24 25 26
#
package Image;

use strict;
27
use Carp;
28
use Exporter;
29
use vars qw(@ISA @EXPORT $AUTOLOAD);
30 31 32 33 34 35

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

# Must come after package declaration!
use libdb;
36
use EmulabConstants;
37 38 39 40 41 42 43 44 45 46 47 48
use libtestbed;
use English;
use Data::Dumper;
use overload ('""' => 'Stringify');

# Configure variables
my $TB		  = "@prefix@";
my $BOSSNODE      = "@BOSSNODE@";
my $CONTROL	  = "@USERNODE@";
my $TBOPS         = "@TBOPSEMAIL@";
my $TBAUDIT       = "@TBAUDITEMAIL@";
my $TBBASE        = "@TBBASE@";
49
my $WWWHOST       = "@WWWHOST@";
50
my $PGENISUPPORT  = @PROTOGENI_SUPPORT@;
51
my $DOPROVENANCE  = @IMAGEPROVENANCE@;
52 53 54 55 56 57
my $TBWWW         = "@TBWWW@";

# Cache of instances to avoid regenerating them.
my %images    = ();
my $debug      = 0;

58 59 60 61 62 63 64
# Concat id/vers.
sub versid($)
{
    my ($self) = @_;

    return $self->imageid() . ":" . $self->version();
}
65 66 67 68 69 70
sub versname($)
{
    my ($self) = @_;

    return $self->pid() . "/" . $self->imagename() . ":" . $self->version();
}
71

72 73 74 75 76 77 78 79 80 81
# Little helper and debug function.
sub mysystem($)
{
    my ($command) = @_;

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

82 83 84 85 86 87 88 89 90 91 92 93
sub BlessRow($$)
{
    my ($class, $row) = @_;
    
    my $self           = {};
    my $imageid        = $row->{"imageid"};
    $self->{'IMAGE'}   = $row;

    bless($self, $class);
    return $self;
}

94
#
95 96
# Lookup by idx or pid,imagename[:version] depending on the args. We always 
# return highest numbered version on this path, if no version specified.
97
#
98
sub Lookup($$;$$)
99
{
100
    my ($class, $arg1, $arg2, $arg3) = @_;
101 102

    #
103 104
    # A single arg is either an index or "pid,imagename[:version]" or
    # "pid/imagename[:version]" string.
105 106 107
    #
    if (!defined($arg2)) {
	if ($arg1 =~ /^(\d*)$/) {
108
	    my $result =
109 110
		DBQueryWarn("select i.*,v.*,i.uuid as image_uuid ".
			    "  from images as i ".
111 112 113 114 115 116 117
			    "left join image_versions as v on ".
			    "     v.imageid=i.imageid and v.version=i.version ".
			    "where i.imageid='$arg1'");
	    return undef
		if (! $result || !$result->numrows);

	    return BlessRow($class, $result->fetchrow_hashref());
118
	}
119
	elsif ($arg1 =~ /^(\d*):(\d*)$/) {
Leigh B Stoller's avatar
Leigh B Stoller committed
120 121 122 123 124 125 126 127 128 129 130 131 132
	    #
	    # This will get deleted images, but that is okay.
	    #
	    my $result =
		DBQueryWarn("select i.*,v.*,i.uuid as image_uuid ".
			    "  from image_versions as v ".
			    "left join images as i on ".
			    "     v.imageid=i.imageid ".
			    "where v.imageid='$1' and v.version='$2'");
	    return undef
		if (! $result || !$result->numrows);

	    return BlessRow($class, $result->fetchrow_hashref());
133
	}
134
	elsif ($arg1 =~ /^([-\w]*),([-\w\.\+]*)$/ ||
135 136
		$arg1 =~ /^([-\w]*)\/([-\w\.\+]*)$/) {
	    my $result =
137 138
		DBQueryWarn("select i.*,v.*,i.uuid as image_uuid ".
			    "  from images as i ".
139 140 141 142 143 144 145 146 147 148 149
			    "left join image_versions as v on ".
			    "     v.imageid=i.imageid and v.version=i.version ".
			    "where i.pid='$1' and i.imagename='$2'");
	    return undef
		if (! $result || !$result->numrows);

	    return BlessRow($class, $result->fetchrow_hashref());
	}
	elsif ($arg1 =~ /^([-\w]*),([-\w\.\+]*):(\d*)$/ ||
		$arg1 =~ /^([-\w]*)\/([-\w\.\+]*):(\d*)$/) {
	    my $result =
150 151
		DBQueryWarn("select i.*,v.*,i.uuid as image_uuid ".
			    "  from images as i ".
152 153
			    "left join image_versions as v on ".
			    "     v.imageid=i.imageid ".
154
			    "where i.pid='$1' and i.imagename='$2' and ".
155
			    "      v.version='$3'");
156 157 158 159
	    return undef
		if (!$result || !$result->numrows);

	    return BlessRow($class, $result->fetchrow_hashref())
160
	}
Leigh B Stoller's avatar
Leigh B Stoller committed
161
	elsif ($arg1 =~ /^\w+\-\w+\-\w+\-\w+\-\w+$/) {
162 163 164 165 166
	    #
	    # First look to see if the uuid is for the image itself,
	    # which means current version. Otherwise look for a
	    # version with the uuid.
	    #
Leigh B Stoller's avatar
Leigh B Stoller committed
167
	    my $result =
168 169 170 171 172 173 174 175 176
		DBQueryWarn("select i.*,v.*,i.uuid as image_uuid ".
			    "  from images as i ".
			    "left join image_versions as v on ".
			    "     v.imageid=i.imageid and v.version=i.version ".
			    "where i.uuid='$arg1'");
	    return undef
		if (!$result);
	    return BlessRow($class, $result->fetchrow_hashref())
		if ($result->numrows);
Leigh B Stoller's avatar
Leigh B Stoller committed
177

178 179 180 181 182 183 184
	    $result =
		DBQueryWarn("select i.*,v.*,i.uuid as image_uuid ".
			    "  from image_versions as v ".
			    "left join images as i on ".
			    "     v.imageid=i.imageid ".
			    "where v.uuid='$arg1' and ".
			    "      v.deleted is null");
Leigh B Stoller's avatar
Leigh B Stoller committed
185 186 187
	    return undef
		if (! $result || !$result->numrows);

188
	    return BlessRow($class, $result->fetchrow_hashref());
Leigh B Stoller's avatar
Leigh B Stoller committed
189
	}
190 191
	return undef;
    }
192 193
    elsif (!defined($arg3)) {
	if ($arg1 =~ /^\d+$/ && $arg2 =~ /^\d+$/) {
194 195 196
	    #
	    # This will get deleted images, but that is okay.
	    #
197
	    my $result =
198
		DBQueryWarn("select i.*,v.*,i.uuid as image_uuid ".
199 200
			    "  from image_versions as v ".
			    "left join images as i on ".
201
			    "     v.imageid=i.imageid ".
202
			    "where v.imageid='$arg1' and v.version='$arg2'");
203 204
	    return undef
		if (! $result || !$result->numrows);
205

206 207 208 209
	    return BlessRow($class, $result->fetchrow_hashref());
	}
	elsif ($arg1 =~ /^[-\w]*$/ && $arg2 =~ /^([-\w\.\+]*):(\d+)$/) {
	    my $result =
210 211
		DBQueryWarn("select i.*,v.*,i.uuid as image_uuid ".
			    "  from images as i ".
212 213 214 215 216 217
			    "left join image_versions as v on ".
			    "     v.imageid=i.imageid ".
			    "where i.pid='$arg1' and i.imagename='$1' and ".
			    "      v.version='$2'");
	    return undef
		if (! $result || !$result->numrows);
218

219 220 221 222
	    return BlessRow($class, $result->fetchrow_hashref());
	}
	elsif ($arg1 =~ /^[-\w]*$/ && $arg2 =~ /^[-\w\.\+]*$/) {
	    my $result =
223 224
		DBQueryWarn("select i.*,v.*,i.uuid as image_uuid ".
			    "  from images as i ".
225 226 227 228 229
			    "left join image_versions as v on ".
			    "     v.imageid=i.imageid and v.version=i.version ".
			    "where i.pid='$arg1' and i.imagename='$arg2'");
	    return undef
		if (! $result || !$result->numrows);
230

231 232 233
	    return BlessRow($class, $result->fetchrow_hashref());
	}
	return undef;
234
    }
235 236 237 238
    else {
	if ($arg1 =~ /^[-\w]*$/ &&
	    $arg2 =~ /^[-\w\.\+]*$/ && $arg3 =~ /^\d+$/) {
	    my $result =
239 240
		DBQueryWarn("select i.*,v.*,i.uuid as image_uuid ".
			    "  from images as i ".
241 242 243
			    "left join image_versions as v on ".
			    "     v.imageid=i.imageid ".
			    "where i.pid='$arg1' and i.imagename='$arg2' and ".
244
			    "      v.version='$arg3'");
245 246
	    return undef
		if (!$result || !$result->numrows);
247

248 249 250 251
	    return BlessRow($class, $result->fetchrow_hashref());
	}
    }
    return undef;
252
}
253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280

AUTOLOAD {
    my $self  = $_[0];
    my $type  = ref($self) or croak "$self is not an object";
    my $name  = $AUTOLOAD;
    $name =~ s/.*://;   # strip fully-qualified portion

    # A DB row proxy method call.
    if (exists($self->{'IMAGE'}->{$name})) {
	return $self->{'IMAGE'}->{$name};
    }
    carp("No such slot '$name' field in class $type");
    return undef;
}

# Break circular reference someplace to avoid exit errors.
sub DESTROY {
    my $self = shift;

    $self->{'IMAGE'} = undef;
}

#
# Lookup by URL.
#
sub LookupByURL($$)
{
    my ($class, $url) = @_;
281
    my ($pid,$imagename);
282 283

    return undef
284
	if (! ($url =~ /^(ftp|http|https):/));
285 286 287 288

    my $safe_url = DBQuoteSpecial($url);
    
    my $query_result =
289 290
	DBQueryWarn("select pid,imagename from image_versions ".
		    "where metadata_url=$safe_url and deleted is null");
291
    return undef
292
	if (!$query_result);
293

294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320
    if ($query_result->numrows) {
	my ($pid,$imagename) = $query_result->fetchrow_array();
	
	# Want latest version.
	return Image->Lookup($pid, $imagename);
    }
    else {
	#
	# If the URL points back to ourself, find the image it refers
	# to. Later phases will catch misuse of the URL (not allowed,
	# does not exist).
	#
	require URI;
	require URI::QueryParam;
	
	my $uri = URI->new($url);
	return undef
	    if (!defined($uri));
	return undef
	    if ($uri->host() ne $WWWHOST);
	my $uuid = $uri->query_param("uuid");
	return undef
	    if (!defined($uuid) || $uuid eq "");

	return Image->Lookup($uuid);
    }
    return undef;
321
}
322 323 324 325 326 327 328
# Image is local if the metadata_url is null.
sub IsLocal($)
{
    my ($self) = @_;

    return (defined($self->metadata_url()) ? 0 : 1);
}
329

330 331 332 333 334 335 336 337 338 339
#
# Lookup a "system" osid, meaning one in the emulab-ops project.
#
sub LookupByName($$)
{
    my ($class, $imagename) = @_;

    return Image->Lookup(TBOPSPID(), $imagename);
}

340 341
#
# Get a list of all running frisbee images.
342 343
# XXX if this is actually used, it will have to be fixed; DB no longer
# tracks running frisbee daemons.
344 345 346 347 348 349 350
#
sub ActiveImages($)
{
    my ($class) = @_;
    my @result  = ();

    my $query_result =
351 352
	DBQueryWarn("select imageid,imageid_version from frisbee_blobs ".
		    "where frisbee_pid!=0");
353 354 355
    return undef
	if (!defined($query_result));

356 357
    while (my ($imageid,$version) = $query_result->fetchrow_array()) {
	my $image = Image->Lookup($imageid, $version);
358 359 360 361 362 363 364 365 366
	if (!defined($image)) {
	    print STDERR "*** Could not find DB object for image $imageid\n";
	    return undef;
	}
	push(@result, $image);
    }
    return \@result;
}

367 368 369 370 371 372 373
#
# Return a list of all images of the given format for the given pid.
# If format is NULL, return all formats. If pid is NULL, return for all pids.
# List is names of the form "pid/imagename".
#
sub ListAll($$$)
{
374
    my ($class, $format, $pid) = @_;
375 376 377 378 379 380 381 382 383
    my @result = ();

    my $clause = "";
    if (defined($format) && $format =~ /^([-\w]+)$/) {
	$clause .= ($clause ? " and" : "where");
	$clause .= " format='$1'";
    }
    if (defined($pid) && $pid =~ /^([-\w]+)$/) {
	$clause .= ($clause ? " and" : "where");
384
	$clause .= " i.pid='$1'";
385 386 387
    }

    my $query_result =
388 389 390 391
	DBQueryWarn("select distinct i.pid,i.imagename from images as i ".
		    "left join image_versions as v on ".
		    "     v.imageid=i.imageid and v.version=i.version ".
		    "$clause order by i.pid,i.imagename");
392 393 394 395 396 397 398 399
    if ($query_result) {
	while (my ($pid,$name) = $query_result->fetchrow_array()) {
	    push(@result, "$pid/$name");
	}
    }
    return @result;
}

400 401 402 403 404 405 406 407 408 409 410
#
# Refresh a class instance by reloading from the DB.
#
sub Refresh($)
{
    my ($self) = @_;

    return -1
	if (! ref($self));

    my $imageid = $self->imageid();
411
    my $version = $self->version();
412 413
    
    my $query_result =
414 415 416 417 418
	DBQueryWarn("select v.*,i.uuid as image_uuid ".
		    "  from image_versions as v ".
		    "left join images as i on ".
		    "     v.imageid=i.imageid ".
		    "where v.imageid='$imageid' and v.version='$version'");
419 420 421 422 423 424 425 426
    return -1
	if (!$query_result || !$query_result->numrows);

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

    return 0;
}

427 428 429 430
#
# Create a new os_info. This installs the new record in the DB,
# and returns an instance. There is some bookkeeping along the way.
#
431
sub Create($$$$$$$$)
432
{
433 434
    my ($class, $project, $group, $creator,
	$imagename, $imageid, $argref, $usrerr_ref) = @_;
435
    require OSinfo;
436 437 438 439 440

    return undef
	if (ref($class) || !ref($project));

    my $isadmin = $creator->IsAdmin();
441 442
    my $isdataset = (exists($argref->{"isdataset"}) ?
		     $argref->{"isdataset"} : 0);
443 444 445 446 447 448

    # We may ignore particular partN_osid's by deleting them.
    my @arg_slots = grep(/^part[1-4]_osid$/, keys(%{$argref}));

    # Pass-through a bunch of required slots, ignoring any extras
    # and stuff we handle explicitly.
449 450 451 452 453 454 455
    if (!$isdataset) {
	foreach my $key ("loadpart", "loadlength", "default_osid") {
	    if (!exists($argref->{$key})) {
		$$usrerr_ref = "Error: $key missing in Image->Create!";
		return undef;
	    }
	    push(@arg_slots, $key);
456 457 458
	}
    }
    # Pass-through optional slots, otherwise the DB default is used.
459
    foreach my $key ("path", "shared", "global", "ezid", "mbr_version",
460 461
		     "metadata_url", "imagefile_url", "released",
		     "isdataset") {
462 463 464 465 466 467 468 469 470 471 472 473 474 475
	if (exists($argref->{$key})) {
	    push(@arg_slots, $key);
	}
    }

    my $pid     = $project->pid();
    my $pid_idx = $project->pid_idx();
    my $gid     = $group->gid();
    my $gid_idx = $group->gid_idx();
    my $uid     = $creator->uid();
    my $uid_idx = $creator->uid_idx();

    #
    # The pid/imageid has to be unique, so lock the table for the check/insert.
476
    # We lock the os_info tables too, for the call into Lookup.
477
    #
478 479 480
    DBQueryWarn("lock tables images write, image_versions write, ".
		"            os_info as o read, os_info_versions as v read, ".
		"            emulab_indicies write")
481 482 483 484 485 486 487 488 489 490 491
	or return undef;

    my $query_result =
	DBQueryWarn("select imagename from images ".
		    "where pid_idx='$pid_idx' and imagename='$imagename'");

    if ($query_result->numrows) {
	DBQueryWarn("unlock tables");
	$$usrerr_ref = "Error: IMAGE $imagename in project $pid already exists!";
	return undef;
    }
492 493 494 495 496 497
    # The metadata_url also has to be unique.
    if (exists($argref->{'metadata_url'})) {
	my $metadata_url = $argref->{'metadata_url'};
	my $safe_url = DBQuoteSpecial($metadata_url);
	
	my $query_result =
498 499
	    DBQueryWarn("select imagename from image_versions ".
			"where metadata_url=$safe_url and deleted is null");
500 501 502 503 504 505 506

	if ($query_result->numrows) {
	    DBQueryWarn("unlock tables");
	    $$usrerr_ref = "Error: IMAGE $metadata_url already exists!";
	    return undef;
	}
    }
507

508 509
    # We allow providing an image descriptor index, so newimageid_ez can use
    # the same name, description, and index for both the OS and Image it makes.
510
    if (defined($imageid) && $imageid > 0 ) {
511 512 513 514 515 516 517 518 519 520
	# Make sure the OS descriptor for it already exists.
	if (!OSinfo->Lookup($imageid)) {
	    DBQueryWarn("unlock tables");
	    $$usrerr_ref = "Error: Missing OSinfo $imagename/$imageid in $pid!";
	    return undef;
	}
    } else {
	#
	# Grab unique ID. Table already locked.
	# 
521
	$imageid  = TBGetUniqueIndex("next_osid", undef, 1);
522
    }
523 524 525 526 527 528 529
    #
    # The image UUID refers to the image, current version. Then each
    # version has its own uuid so it can be referred to. 
    #
    my $image_uuid   = NewUUID();
    my $version_uuid = NewUUID();
    #
530 531
    # Some fields special cause of quoting.
    #
532
    my $desc  = "''";
533 534 535 536
    if (exists($argref->{'description'})) {
	$desc = DBQuoteSpecial($argref->{'description'});
    }
    
537 538 539 540
    my $bquery = "imagename='$imagename'";
    $bquery .= ",imageid='$imageid'";
    $bquery .= ",pid='$pid',pid_idx='$pid_idx'";
    $bquery .= ",gid='$gid',gid_idx='$gid_idx'";
541

542 543 544
    my $query = "insert into image_versions set $bquery, ".
	join(",", map("$_='" . $argref->{$_} . "'", @arg_slots));
    
545
    $query .= ",creator='$uid',creator_idx='$uid_idx'";
546
    $query .= ",uuid='$version_uuid'";
547
    $query .= ",created=now()";
Leigh B Stoller's avatar
Leigh B Stoller committed
548 549 550
    $query .= ",description=$desc";
    $query .= ",hash=" . DBQuoteSpecial($argref->{'hash'})
	if (exists($argref->{'hash'}));
551 552 553 554 555 556 557 558 559

    #
    # If this is set in the environment, we use it. This allows
    # us to track actual geni users, since all of that happens
    # as geniuser. We do not bother to set this for local users.
    #
    if (exists($ENV{'GENIURN'}) && $ENV{'GENIURN'} ne "") {
	$query .= ",creator_urn=". DBQuoteSpecial($ENV{'GENIURN'});
    }
560 561

    # Create the main entry:
562
    if (! DBQueryWarn("insert into images set $bquery,uuid='$image_uuid'")) {
563 564 565 566 567
	DBQueryWarn("unlock tables");
	tberror("Error inserting new images record for $pid/$imagename!");
	return undef;
    }
    # And the other entry.
568
    if (! DBQueryWarn($query)) {
569
	DBQueryWarn("delete from images where uuid='$image_uuid'");
570 571 572 573
	DBQueryWarn("unlock tables");
	tberror("Error inserting new images record for $pid/$imagename!");
	return undef;
    }
574
    DBQueryWarn("unlock tables");
575 576 577 578 579

    my $image = Image->Lookup($imageid);
    # Create the osidtoimageid mapping.  Admins have an option to do it or not.
    my $makedefault = exists($argref->{"makedefault"}) && 
	$argref->{"makedefault"} eq "1";
580
    if (!$isdataset && (!$isadmin || $makedefault)) {
581
	#
582 583 584
	# Dig out the mtypes we want to turn on. The caller has already
	# sanity checked them to make sure the types actually exist, and
	# that there are nodes matching that type.
585
	#
586 587 588 589 590
	my @map_updates = ();
	foreach my $key (grep(/^mtype_/, keys(%{$argref}))) {
	    if ($argref->{$key} eq "1") {
		$key =~ s/^mtype_//;
		push(@map_updates, $key);
591 592 593
	    }
	}

594
	my @osid_array = ();
595
	for (my $i = 1; $i <= 4; $i++) {
596 597
	    my $func = "part${i}_osid";
	    my $foo  = $image->$func();
598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619
	    if (defined($foo)) {
		push(@osid_array, $foo);
	    }
	}

	for (my $i = 0; $i <= $#map_updates; $i++) {
	    for (my $j = 0; $j <= $#osid_array; $j++) {
		 my $query = "INSERT INTO osidtoimageid ".
			     "       (osid, type, imageid) ".
			     "VALUES ('$osid_array[$j]', ".
			     "        '$map_updates[$i]', ".
			     "        '$imageid')";
		 ##print "$query\n";
		 if (! DBQueryWarn($query)) {
		     DBQueryWarn("unlock tables");
		     tberror("Error inserting new ostoimageid mapping for ".
			     "$pid/$imagename!");
		     return undef;
		 }
	    }
	}
    }
620 621 622 623 624 625
    return $image;
}

#
# Clone an image descriptor from the DB, bumping the version number
#
626
sub NewVersion($$$$)
627
{
628
    my ($self, $creator, $baseimage, $usrerr_ref) = @_;
629 630 631
    my $osid        = $self->imageid();
    my $version     = $self->version();
    my $tableid     = int(rand(10000000));
632
    my $typelist    = "";
633 634 635 636 637 638 639 640
    my $ostablename = "os_info_versions" . $tableid;
    my $imtablename = "image_versions"  . $tableid;

    #
    # The pid/imageid has to be unique, so lock the table for the check/insert.
    #
    DBQueryWarn("lock tables images write, image_versions write, ".
		"            os_info write, os_info_versions write, ".
641
		"            emulab_indicies write, osidtoimageid read")
642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657
	or return undef;

    my $query_result =
	DBQueryWarn("create temporary table $ostablename ".
		    "select * from os_info_versions ".
		    "  where osid='$osid' and vers='$version'");
    goto bad
	if (!$query_result);

    $query_result =
	DBQueryWarn("create temporary table $imtablename ".
		    "select * from image_versions ".
		    "where imageid='$osid' and version='$version'");
    goto bad
	if (!$query_result);

658 659 660 661 662 663 664 665 666 667
    #
    # Grab the current type list.
    #
    $query_result =
	DBQueryWarn("select distinct type from osidtoimageid ".
		    "where imageid='$osid'");
    
    goto bad
	if (!$query_result);

Leigh B Stoller's avatar
Leigh B Stoller committed
668 669 670
    my @types = ();
    while (my ($type) = $query_result->fetchrow_array()) {
	push(@types, $type);
671
    }
Leigh B Stoller's avatar
Leigh B Stoller committed
672
    $typelist = join(",", @types);
673

674 675 676 677 678 679 680 681
    #
    # Update the type list in the image being cloned. Better to do this
    # when the types are changed, but this works too since no one uses
    # this until the image is deleted.
    #
    DBQueryWarn("update image_versions set nodetypes='$typelist' ".
		"where imageid='$osid' and version='$version'");

682 683 684 685
    #
    # Now reset a few things in each table.
    #
    my $clone_vers  = $self->version() + 1;
686
    my $updater_urn = "";
687 688 689 690 691 692
    #
    # If this is set in the environment, we use it. This allows
    # us to track actual geni users, since all of that happens
    # as geniuser. We do not bother to set this for local users.
    #
    if (exists($ENV{'GENIURN'}) && $ENV{'GENIURN'} ne "") {
693
	$updater_urn = ",updater_urn=". DBQuoteSpecial($ENV{'GENIURN'});
694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714
    }
    #
    # Figure out which partition needs to be changed. EZ images only
    # at this time.
    #
    my $part_vers = "";
    for (my $i = 1; $i <= 4; $i++) {
	my $func = "part${i}_osid";
	if (defined($self->$func())) {
	    $part_vers = "part${i}_vers='${clone_vers}'";
	    last;
	}
    }

    my $uid     = $creator->uid();
    my $uid_idx = $creator->uid_idx();

    #
    # The parent of this image might be this image, if taking a snapshot
    # of a node running the image. But we also need to support making a
    # version of the image, from a node running some other image. We still
715 716 717 718 719
    # bump the version number, but the parent pointers are different.
    #
    # In one case, the base image is undef, which indicates a new version
    # not based on anything; we use this from the image_import with
    # update path. Not sure it is the correct approach yet.
720 721
    #
    my ($parent_imageid, $parent_version);
722 723 724 725

    if (!defined($baseimage)) {
	$parent_imageid = "NULL";
	$parent_version = "NULL";
726 727
    }
    else {
728 729 730 731 732 733 734 735 736 737
	if ($self->imageid() == $baseimage->imageid()) {
	    $parent_imageid = $self->imageid();
	    $parent_version = $self->version();
	}
	else {
	    $parent_imageid = $baseimage->imageid();
	    $parent_version = $baseimage->version();
	}
	$parent_imageid = "'$parent_imageid'";
	$parent_version = "'$parent_version'";
738 739 740 741 742 743 744 745 746 747 748 749
    }

    #
    # Fix up the path by appending the version number.
    #
    my $path = $self->path();
    if ($path =~ /^(.*):\d+$/) {
	$path = $1 . ":${clone_vers}";
    }
    else {
	$path .= ":${clone_vers}";
    }
750

751 752 753
    DBQueryWarn("update $ostablename set ".
		"  uuid=uuid(), ".
		"  vers='$clone_vers',".
754 755
		"  parent_osid=$parent_imageid,".
		"  parent_vers=$parent_version ".
756 757 758 759
		"where osid='$osid'")
	or goto bad;

    DBQueryWarn("update $imtablename set ".
Leigh B Stoller's avatar
Leigh B Stoller committed
760
		"  uuid=uuid(),ready=0,path='$path',released=0, ".
761 762
		"  $part_vers, default_vers='$clone_vers', ".
		"  version='$clone_vers',".
763
		"  created=now(),nodetypes='$typelist', ".
764 765
		"  parent_imageid=$parent_imageid,".
		"  parent_version=$parent_version, ".
766
		"  updater='$uid',updater_idx='$uid_idx' $updater_urn ".
767 768 769 770 771
		"where imageid='$osid'")
	or goto bad;

    #
    # And insert into the real table. At this point we will be
772
    # inconsistent if we crash before the commit is done.
773 774 775 776
    #
    if (! (DBQueryWarn("insert into os_info_versions ".
		       "select * from $ostablename") &&
	   DBQueryWarn("insert into image_versions ".
777
		       "select * from $imtablename"))) {
778 779 780 781 782 783 784 785
	DBQueryWarn("delete from os_info_versions ".
		    "where osid='$osid' and vers='$clone_vers'");
	DBQueryWarn("delete from image_versions ".
		    "where imageid='$osid' and version='$clone_vers'");
	goto bad;
    }
    
    DBQueryWarn("unlock tables");
786
    return Image->Lookup($osid, $clone_vers);
787
  bad:
788
    DBQueryWarn("unlock tables");
789 790
    return undef;
}
791

792 793 794 795 796 797 798 799 800 801 802 803 804 805 806
#
# For a newly created image, set the provenance pointers back to
# the image from which it was derived.
#
sub SetProvenance($$)
{
    my ($self, $base) = @_;
    my $parent_imageid = $base->imageid();
    my $parent_version = $base->version();

    $self->Update({"parent_imageid" => $parent_imageid,
		   "parent_version" => $parent_version})
	== 0 or return -1;

    return 0;
807 808
}

809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828
#
# Highest number version, rather then what is deemed most recent by the
# images table.
#
sub LookupMostRecent($)
{
    my ($self) = @_;

    my $imageid = $self->imageid();

    my $query_result =
	DBQueryWarn("select version from image_versions ".
		    "where imageid='$imageid' order by version desc limit 1");
    return undef
	if (!$query_result);

    my ($version) = $query_result->fetchrow_array();
    return Image->Lookup($imageid, $version);
}

829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855
#
# Return a list of all image versions.
#
sub AllVersions($$)
{
    my ($self, $pref)  = @_;
    my @result  = ();
    my $imageid = $self->imageid();

    my $query_result =
	DBQueryWarn("select version from image_versions ".
		    "where imageid='$imageid' order by version desc");
    return -1
	if (!$query_result);
    
    while (my ($version) = $query_result->fetchrow_array()) {
	my $image = Image->Lookup($imageid, $version);
	if (!defined($image)) {
	    print STDERR "Could not lookup image $imageid,$version\n";
	    return -1;
	}
	push(@result, $image);
    }
    @$pref = @result;
    return 0;
}

856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905
#
# Release an image; all this does is make the highest numbered version
# in the image_versions table, the default version. It does this by
# updating the version number in the images table. An unreleased version
# can be used by explicitly giving the version number, but unqualified
# use always get the version that is set in the images table. 
#
sub Release($)
{
    my ($self) = @_;

    DBQueryWarn("lock tables images write, image_versions write, ".
		"            os_info write, os_info_versions write")
	or return -1;

    if (!$self->ready()) {
	print STDERR "Image::Release: $self is not marked ready!\n";
	goto bad;
    }
    my $imageid = $self->imageid();
    my $version = $self->version();

    #
    # Only the "head" version can be released.
    #
    my $query_result =
	DBQueryWarn("select max(version) from image_versions ".
		    "where imageid='$imageid'");
    goto bad
	if (!$query_result || !$query_result->numrows);

    my ($head) = $query_result->fetchrow_array();
    if ($head != $self->version()) {
	print STDERR "Image::Release: not the head version of $self\n";
	goto bad;
    }
    return -1
	if (! (DBQueryWarn("update os_info set version='$version' ".
			   "where osid='$imageid'") &&
	       DBQueryWarn("update images set version='$version' ".
			   "where imageid='$imageid'") &&
	       DBQueryWarn("update image_versions set released=1 ".
			   "where imageid='$imageid' and version='$version'")));
    DBQueryWarn("unlock tables");
    return 0;
  bad:
    DBQueryWarn("unlock tables");
    return -1;
}

906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923
#
# Worker class method to edit image descriptor.
# Assumes most argument checking was done elsewhere.
#
sub EditImageid($$$$)
{
    my ($class, $image, $argref, $usrerr_ref) = @_;

    my %mods;
    my $noreport;

    my $imageid = $image->imageid();

    #
    # Now update the rest of the information in the DB.
    # (Others above already did their own updates.)
    #
    my %updates;
924
    foreach my $col ("description", "path", "mbr_version", "hash", "notes") {
925 926 927 928 929 930 931 932 933 934 935 936 937
	# Copy args we want so that others can't get through.
	if (exists($argref->{$col})) {
	    $updates{$col} = $mods{$col} = $argref->{$col};
	}
    }
    # See mtype_$type args below.

    #
    # Need a list of node types. We join this over the nodes table so that
    # we get a list of just the nodes that are currently in the testbed, not
    # just in the node_types table.
    #
    my $types_result =
938
	DBQueryWarn("select distinct n.type from nodes as n ".
939 940 941 942 943 944 945 946
		     "left join node_type_attributes as a on a.type=n.type ".
		     "where a.attrkey='imageable' and ".
		     "      a.attrvalue!='0'");
    my @mtypes_array;
    my @map_updates;
    my $redo_map = 0;
    while (my ($type) = $types_result->fetchrow_array()) {
	push(@mtypes_array, $type);
947 948 949 950 951
    }
    #
    # Special hack to allow pcvm type -- see SetupReload in os_setup
    #
    push @mtypes_array, "pcvm";
952

953
    foreach my $type (@mtypes_array) {
954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977
	# Remember when we get one of the mtype_$type args.  These aren't DB
	# columns to update, but instead control re-creating the rows in the
	# osidtoimageid table for this imageid, below.
	my $mtype = "mtype_$type";
	if (exists($argref->{$mtype})) {
	    my $value = $argref->{$mtype};
	    ##printf "argref->{$mtype} %s\n", $value;
	    $mods{$mtype} = $value;
	    if ($value eq "1") {
		push(@map_updates, $type);
		$redo_map = 1;
	    }
	}
    }

    if (!keys %mods) {
	if (!$noreport) {
	    # Warn the user that the submit button was pressed with no effect.
	    $$usrerr_ref = "Submit: Nothing changed";
	    return undef;
	}
    }

    if (keys %updates || $redo_map) {
978
	DBQueryWarn("lock tables images write, image_versions write, ".
Leigh B Stoller's avatar
Leigh B Stoller committed
979
		    "     images as i write, image_versions as v write, ".
980 981
		    "     os_info write, os_info_versions write, ".
		    "     osidtoimageid write");
982 983 984 985
    }
    if (keys %updates) {
	if ($image->Update(\%updates)) {
	    $$usrerr_ref = "DB: Error updating the images table";
986
	    DBQueryWarn("unlock tables");
987 988 989 990 991 992 993 994
	    return undef;
	}
    }
    if ($redo_map) {
	#
	# Update the osidtoimageid table too.
	# 
	# Must delete old entries first.
995
	DBQueryWarn("delete from osidtoimageid ".
996 997 998 999
		     "where imageid='$imageid'");

	my @osid_array;
	for (my $i = 1; $i <= 4; $i++) {
1000 1001
	    my $func = "part${i}_osid";
	    my $foo  = $image->$func();
1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013
	    if (defined($foo)) {
		push(@osid_array, $foo);
	    }
	}
	for (my $i = 0; $i <= $#map_updates; $i++) {
	    for (my $j = 0; $j <= $#osid_array; $j++) {
		 my $query = "REPLACE INTO osidtoimageid ".
			     "       (osid, type, imageid) ".
			     "VALUES ('$osid_array[$j]', ".
			     "        '$map_updates[$i]', ".
			     "        '$imageid')";
		 ##print "$query\n";
1014
		 DBQueryWarn($query);
1015 1016 1017 1018
	    }
	}
    }
    if (keys %updates || $redo_map) {
1019
	DBQueryWarn("unlock tables");
1020 1021 1022 1023 1024
    }

    return 1;
}

1025 1026 1027 1028 1029 1030 1031 1032 1033
#
# Stringify for output.
#
sub Stringify($)
{
    my ($self) = @_;
    
    my $pid       = $self->pid();
    my $imageid   = $self->imageid();
1034
    my $version   = $self->version();
1035 1036
    my $imagename = $self->imagename();

1037
    return "[Image $imageid:$version $pid,$imagename]";
1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064
}

#
# Return the internal DB rowref. Used for code that has not been converted.
#
sub DBData($)
{
    my ($self) = @_;

    return undef
	if (! ref($self));

    return $self->{'IMAGE'}
}

#
# Perform some updates ...
#
sub Update($$)
{
    my ($self, $argref) = @_;

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

    my $imageid = $self->imageid();
1065
    my $version = $self->version();
1066

1067 1068
    my $query = 
	join(",", map("$_=" . DBQuoteSpecial($argref->{$_}), keys(%{$argref})));
1069

1070
    $query .= " where imageid='$imageid' and version='$version'";
1071 1072

    return -1
1073 1074
	if (! DBQueryWarn("update image_versions set $query"));
	    
1075 1076 1077
    return Refresh($self);
}

1078
#
1079
# Delete an image,
1080
#
1081
sub Delete($;$)
1082
{
1083
    my ($self, $purge) = @_;
1084 1085 1086 1087 1088

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

1089 1090 1091 1092
    $purge = 0
	if (!defined($purge));
    
    my $imageid   = $self->imageid();
1093
    my $uuid      = $self->image_uuid();
1094

1095 1096 1097
    DBQueryWarn("lock tables images write, image_versions write, ".
		"            os_info write, os_info_versions write, ".
		"            osidtoimageid write, os_submap write, ".
1098
		"            image_permissions write, node_types read")
1099 1100
	or return -1;

1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113
    #
    # If provenance is on and not purging, then want to stash the
    # current type list so we can recall it later. 
    #
    if (!$purge && $DOPROVENANCE && !defined($self->nodetypes())) {
	my @typelist = $self->TypeList();
	if (@typelist) {
	    my $typelist = join(",", @typelist);
	    DBQueryWarn("update image_versions set nodetypes='$typelist' ".
			"where imageid='$imageid'")
	}
    }

1114 1115 1116 1117 1118 1119 1120
    #
    # If this is an EZ imageid, then delete the corresponding OSID too.
    #
    DBQueryWarn("delete from osidtoimageid where imageid='$imageid'")
	or goto bad;
    DBQueryWarn("delete from images where imageid='$imageid'")
	or goto bad;
Leigh B Stoller's avatar
Leigh B Stoller committed
1121
    DBQueryWarn("delete from web_tasks where object_uuid='$uuid'") or
1122
	return -1;
1123
    
1124
    if ($purge || !$DOPROVENANCE) {
1125
	goto bad
Leigh B Stoller's avatar
Leigh B Stoller committed
1126 1127
	    if (! DBQueryWarn("delete from image_versions ".
			      "where imageid='$imageid'"));
1128 1129 1130 1131 1132 1133 1134 1135
    }
    else {
	# Set deleted on all of the versions.
	DBQueryWarn("update image_versions set ".
		    "    deleted=now(),locked=null,locker_pid=0 ".
		    "where imageid='$imageid'")
	    or goto bad;
    }
1136 1137 1138 1139 1140
    if ($self->ezid()) {
	DBQueryWarn("delete from os_submap where osid='$imageid'")
	    or goto bad;
	DBQueryWarn("delete from os_info where osid='$imageid'")
	    or goto bad;
1141
	if ($purge || !$DOPROVENANCE) {
1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153
	    DBQueryWarn("delete from os_info_versions where osid='$imageid'")
		or goto bad;
	}
	else {
	    # Set deleted on all of the versions.
	    DBQueryWarn("update os_info_versions set deleted=now() ".
			"where osid='$imageid'")
		or goto bad;
	}
	# Kill off the imageid permissions.
	DBQueryWarn("delete from image_permissions where imageid='$imageid'")
	    or goto bad;
1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164
    }
    DBQueryWarn("unlock tables")
	or return -1;

    return 0;

  bad:
    DBQueryWarn("unlock tables");
    return -1;
}

1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180
#
# Delete a version of an image. This is not to be used, except when there
# is an error during clone, and we want to undo the creation of a new version.
#
sub DeleteVersion($)
{
    my ($self) = @_;

    my $imageid   = $self->imageid();

    DBQueryWarn("lock tables images write, image_versions write, ".
		"            os_info write, os_info_versions write")
	or return -1;

    #
    # We do not allow the deletion if it is not the "head" version of the
1181
    # image_versions. Maybe later.
1182 1183
    #
    my $query_result =
1184 1185
	DBQueryWarn("select max(version) from image_versions ".
		    "where imageid='$imageid'");
1186
    goto bad
1187 1188 1189 1190
	if (!$query_result || !$query_result->numrows);

    my ($version) = $query_result->fetchrow_array();
    if ($version != $self->version()) {
1191 1192 1193 1194 1195 1196 1197 1198
	print STDERR "Image::DeleteVersion: not the head version of $self\n";
	goto bad;
    }

    goto bad
	if (! (DBQueryWarn("delete from image_versions ".
			   "where imageid='$imageid' and version='$version'") &&
	       DBQueryWarn("delete from os_info_versions ".
1199
			   "where osid='$imageid' and vers='$version'")));
1200 1201 1202 1203 1204 1205 1206 1207 1208 1209

    DBQueryWarn("unlock tables")
	or return -1;
    return 0;

  bad:
    DBQueryWarn("unlock tables");
    return -1;
}

1210
#
1211 1212 1213 1214 1215
# Load the project object for an image
#
sub GetProject($)
{
    my ($self) = @_;
1216
    require Project;
1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236

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

    my $project = Project->Lookup($self->pid_idx());
    
    if (! defined($project)) {
	print("*** WARNING: Could not lookup project object for $self!", 1);
	return undef;
    }
    return $project;
}

#
# Load the group object for an image
#
sub GetGroup($)
{
    my ($self) = @_;
1237
    require Group;
1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254

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

    my $group = Group->Lookup($self->gid_idx());
    
    if (! defined($group)) {
	print("*** WARNING: Could not lookup group object for $self!", 1);
	return undef;
    }
    return $group;
}

#
# Check permissions. Note that root may ask permission, which comes in
# as an undef user.
1255 1256 1257 1258
#
sub AccessCheck($$$)
{
    my ($self, $user, $access_type) = @_;
1259
    require Group;
1260 1261

    # Must be a real reference. 
1262
    return 0