Image.pm.in 62.6 KB
Newer Older
1 2
#!/usr/bin/perl -wT
#
3
# Copyright (c) 2007-2016 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
use libtestbed;
use English;
use Data::Dumper;
40
use File::Basename;
41 42 43 44 45 46 47 48 49
use overload ('""' => 'Stringify');

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

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

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

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

    return $self->pid() . "/" . $self->imagename() . ":" . $self->version();
}
73 74 75 76 77 78 79 80 81 82 83
sub urn($)
{
    my ($self) = @_;

    return undef
	if (! $PGENISUPPORT);

    require GeniHRN;
    return GeniHRN::Generate($OURDOMAIN, "image",
			     $self->pid() . "//" . $self->imagename());
}    
84

85 86 87 88 89 90 91 92 93 94
# Little helper and debug function.
sub mysystem($)
{
    my ($command) = @_;

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

95 96 97
sub BlessRow($$)
{
    my ($class, $row) = @_;
98

99 100 101
    my $self           = {};
    my $imageid        = $row->{"imageid"};
    $self->{'IMAGE'}   = $row;
102
    $self->{'HASH'}    = {};
103 104 105 106 107

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

108
#
109 110
# Lookup by idx or pid,imagename[:version] depending on the args. We always 
# return highest numbered version on this path, if no version specified.
111
#
112
sub Lookup($$;$$)
113
{
114
    my ($class, $arg1, $arg2, $arg3) = @_;
115 116

    #
117 118
    # A single arg is either an index or "pid,imagename[:version]" or
    # "pid/imagename[:version]" string.
119 120 121
    #
    if (!defined($arg2)) {
	if ($arg1 =~ /^(\d*)$/) {
122
	    my $result =
123 124
		DBQueryWarn("select i.*,v.*,i.uuid as image_uuid, ".
			    "   i.metadata_url as image_metadata_url ".
125
			    "  from images as i ".
126 127 128 129 130 131 132
			    "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());
133
	}
134
	elsif ($arg1 =~ /^(\d*):(\d*)$/) {
Leigh B Stoller's avatar
Leigh B Stoller committed
135 136 137 138
	    #
	    # This will get deleted images, but that is okay.
	    #
	    my $result =
139 140
		DBQueryWarn("select i.*,v.*,i.uuid as image_uuid, ".
			    "   i.metadata_url as image_metadata_url ".
Leigh B Stoller's avatar
Leigh B Stoller committed
141 142 143 144 145 146 147 148
			    "  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());
149
	}
150
	elsif ($arg1 =~ /^([-\w]*),([-\w\.\+]*)$/ ||
151 152
		$arg1 =~ /^([-\w]*)\/([-\w\.\+]*)$/) {
	    my $result =
153 154
		DBQueryWarn("select i.*,v.*,i.uuid as image_uuid, ".
			    "   i.metadata_url as image_metadata_url ".
155
			    "  from images as i ".
156 157 158 159 160 161 162 163 164 165 166
			    "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 =
167 168
		DBQueryWarn("select i.*,v.*,i.uuid as image_uuid, ".
			    "   i.metadata_url as image_metadata_url ".
169
			    "  from images as i ".
170 171
			    "left join image_versions as v on ".
			    "     v.imageid=i.imageid ".
172
			    "where i.pid='$1' and i.imagename='$2' and ".
173
			    "      v.version='$3'");
174 175 176 177
	    return undef
		if (!$result || !$result->numrows);

	    return BlessRow($class, $result->fetchrow_hashref())
178
	}
Leigh B Stoller's avatar
Leigh B Stoller committed
179
	elsif ($arg1 =~ /^\w+\-\w+\-\w+\-\w+\-\w+$/) {
180 181 182 183 184
	    #
	    # 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
185
	    my $result =
186 187
		DBQueryWarn("select i.*,v.*,i.uuid as image_uuid, ".
			    "   i.metadata_url as image_metadata_url ".
188 189 190 191 192 193 194 195
			    "  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
196

197
	    $result =
198 199
		DBQueryWarn("select i.*,v.*,i.uuid as image_uuid, ".
			    "   i.metadata_url as image_metadata_url ".
200 201 202 203 204
			    "  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
205 206 207
	    return undef
		if (! $result || !$result->numrows);

208
	    return BlessRow($class, $result->fetchrow_hashref());
Leigh B Stoller's avatar
Leigh B Stoller committed
209
	}
210 211
	return undef;
    }
212 213
    elsif (!defined($arg3)) {
	if ($arg1 =~ /^\d+$/ && $arg2 =~ /^\d+$/) {
214 215 216
	    #
	    # This will get deleted images, but that is okay.
	    #
217
	    my $result =
218 219
		DBQueryWarn("select i.*,v.*,i.uuid as image_uuid, ".
			    "   i.metadata_url as image_metadata_url ".
220 221
			    "  from image_versions as v ".
			    "left join images as i on ".
222
			    "     v.imageid=i.imageid ".
223
			    "where v.imageid='$arg1' and v.version='$arg2'");
224 225
	    return undef
		if (! $result || !$result->numrows);
226

227 228 229 230
	    return BlessRow($class, $result->fetchrow_hashref());
	}
	elsif ($arg1 =~ /^[-\w]*$/ && $arg2 =~ /^([-\w\.\+]*):(\d+)$/) {
	    my $result =
231 232
		DBQueryWarn("select i.*,v.*,i.uuid as image_uuid, ".
			    "   i.metadata_url as image_metadata_url ".
233
			    "  from images as i ".
234 235 236 237 238 239
			    "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);
240

241 242 243 244
	    return BlessRow($class, $result->fetchrow_hashref());
	}
	elsif ($arg1 =~ /^[-\w]*$/ && $arg2 =~ /^[-\w\.\+]*$/) {
	    my $result =
245 246
		DBQueryWarn("select i.*,v.*,i.uuid as image_uuid, ".
			    "   i.metadata_url as image_metadata_url ".
247
			    "  from images as i ".
248 249 250 251 252
			    "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);
253

254 255 256
	    return BlessRow($class, $result->fetchrow_hashref());
	}
	return undef;
257
    }
258 259 260 261
    else {
	if ($arg1 =~ /^[-\w]*$/ &&
	    $arg2 =~ /^[-\w\.\+]*$/ && $arg3 =~ /^\d+$/) {
	    my $result =
262 263
		DBQueryWarn("select i.*,v.*,i.uuid as image_uuid, ".
			    "   i.metadata_url as image_metadata_url ".
264
			    "  from images as i ".
265 266 267
			    "left join image_versions as v on ".
			    "     v.imageid=i.imageid ".
			    "where i.pid='$arg1' and i.imagename='$arg2' and ".
268
			    "      v.version='$arg3'");
269 270
	    return undef
		if (!$result || !$result->numrows);
271

272 273 274 275
	    return BlessRow($class, $result->fetchrow_hashref());
	}
    }
    return undef;
276
}
277 278 279 280 281 282 283 284 285

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})) {
286 287 288 289
	# Allow update.
	if (scalar(@_) == 2) {
	    $self->{'IMAGE'}->{$name} = $_[1];
	}
290 291
	return $self->{'IMAGE'}->{$name};
    }
292 293 294 295 296 297 298 299 300
    # Or it is for a local storage slot.
    if ($name =~ /^_.*$/) {
	if (scalar(@_) == 2) {
	    return $self->{'HASH'}->{$name} = $_[1];
	}
	elsif (exists($self->{'HASH'}->{$name})) {
	    return $self->{'HASH'}->{$name};
	}
    }
301 302 303
    carp("No such slot '$name' field in class $type");
    return undef;
}
Leigh B Stoller's avatar
Leigh B Stoller committed
304 305 306 307 308 309 310 311
sub field($$) {
    my ($self, $name) = @_;
    
    if (exists($self->{'IMAGE'}->{$name})) {
	return $self->{'IMAGE'}->{$name};
    }
    return undef;
}
312 313 314 315 316 317

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

    $self->{'IMAGE'} = undef;
318
    $self->{'HASH'}  = undef;
319 320 321 322 323 324 325 326
}

#
# Lookup by URL.
#
sub LookupByURL($$)
{
    my ($class, $url) = @_;
327
    my ($pid,$imagename);
328 329

    return undef
330
	if (! ($url =~ /^(ftp|http|https):/));
331 332

    my $safe_url = DBQuoteSpecial($url);
333 334 335 336

    #
    # First check for a non version specific URL (latest version).
    #
337
    my $query_result =
338 339
	DBQueryWarn("select pid,imagename from images ".
		    "where metadata_url=$safe_url");
340
    return undef
341
	if (!$query_result);
342

343 344 345 346 347
    if ($query_result->numrows) {
	my ($pid,$imagename) = $query_result->fetchrow_array();
	
	return Image->Lookup($pid, $imagename);
    }
348 349 350 351 352 353 354 355 356 357 358 359 360 361 362
    
    #
    # Then a version specific URL.
    #
    $query_result =
	DBQueryWarn("select pid,imagename,version from image_versions ".
		    "where metadata_url=$safe_url and deleted is null");
    return undef
	if (!$query_result);

    if ($query_result->numrows) {
	my ($pid,$imagename,$version) = $query_result->fetchrow_array();
	
	return Image->Lookup($pid, $imagename, $version);
    }
363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383
    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;
384
}
385 386 387 388 389 390 391
# Image is local if the metadata_url is null.
sub IsLocal($)
{
    my ($self) = @_;

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

393 394 395 396 397 398 399 400 401 402
#
# Lookup a "system" osid, meaning one in the emulab-ops project.
#
sub LookupByName($$)
{
    my ($class, $imagename) = @_;

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

403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422
#
# Lookup by Origin UUID.
#
sub LookupByOriginUUID($$$)
{
    my ($class, $pid, $uuid) = @_;
    my $safe_uuid = DBQuoteSpecial($uuid);
    my $safe_pid = DBQuoteSpecial($pid);

    my $query_result =
	DBQueryWarn("select imageid from image_versions ".
		    "where pid=$safe_pid ".
		    "      origin_uuid=$safe_uuid and deleted is null");
    return undef
	if (!$query_result || !$query_result->numrows);

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

423 424
#
# Get a list of all running frisbee images.
425 426
# XXX if this is actually used, it will have to be fixed; DB no longer
# tracks running frisbee daemons.
427 428 429 430 431 432 433
#
sub ActiveImages($)
{
    my ($class) = @_;
    my @result  = ();

    my $query_result =
434 435
	DBQueryWarn("select imageid,imageid_version from frisbee_blobs ".
		    "where frisbee_pid!=0");
436 437 438
    return undef
	if (!defined($query_result));

439 440
    while (my ($imageid,$version) = $query_result->fetchrow_array()) {
	my $image = Image->Lookup($imageid, $version);
441 442 443 444 445 446 447 448 449
	if (!defined($image)) {
	    print STDERR "*** Could not find DB object for image $imageid\n";
	    return undef;
	}
	push(@result, $image);
    }
    return \@result;
}

450 451 452 453 454 455 456
#
# 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($$$)
{
457
    my ($class, $format, $pid) = @_;
458 459 460 461 462 463 464 465 466
    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");
467
	$clause .= " i.pid='$1'";
468 469 470
    }

    my $query_result =
471 472 473 474
	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");
475 476 477 478 479 480 481 482
    if ($query_result) {
	while (my ($pid,$name) = $query_result->fetchrow_array()) {
	    push(@result, "$pid/$name");
	}
    }
    return @result;
}

483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515
#
# Return a list of all versions 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:version".
#
sub ListAllVersions($$$)
{
    my ($class, $format, $pid) = @_;
    my @result = ();

    my $clause = "";
    if (defined($format) && $format =~ /^([-\w]+)$/) {
	$clause .= "and v.format='$1'";
    }
    if (defined($pid) && $pid =~ /^([-\w]+)$/) {
	$clause .= "and v.pid='$1'";
    }

    my $query_result =
	DBQueryWarn("select v.pid,v.imagename,v.version from ".
		    "images as i, image_versions as v where ".
		    "i.imageid=v.imageid and v.deleted is null ".
		    "$clause order by v.pid,v.imagename,v.version");
    if ($query_result) {
	while (my ($pid,$name,$vers) = $query_result->fetchrow_array()) {
	    push(@result, "$pid/$name:$vers");
	}
    }
    return @result;
}

516 517 518 519 520 521 522 523 524 525 526
#
# Refresh a class instance by reloading from the DB.
#
sub Refresh($)
{
    my ($self) = @_;

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

    my $imageid = $self->imageid();
527
    my $version = $self->version();
528 529
    
    my $query_result =
530
	DBQueryWarn("select v.*,i.uuid as image_uuid,i.locked,i.locker_pid ".
531 532 533 534
		    "  from image_versions as v ".
		    "left join images as i on ".
		    "     v.imageid=i.imageid ".
		    "where v.imageid='$imageid' and v.version='$version'");
535 536 537 538 539 540 541 542
    return -1
	if (!$query_result || !$query_result->numrows);

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

    return 0;
}

543 544 545 546
#
# Create a new os_info. This installs the new record in the DB,
# and returns an instance. There is some bookkeeping along the way.
#
547
sub Create($$$$$$$$)
548
{
549 550
    my ($class, $project, $group, $creator,
	$imagename, $imageid, $argref, $usrerr_ref) = @_;
551
    require OSinfo;
552 553 554 555 556

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

    my $isadmin = $creator->IsAdmin();
557 558
    my $isdataset = (exists($argref->{"isdataset"}) ?
		     $argref->{"isdataset"} : 0);
559 560 561 562 563 564

    # 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.
565 566 567 568 569 570 571
    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);
572 573 574
	}
    }
    # Pass-through optional slots, otherwise the DB default is used.
575
    foreach my $key ("path", "shared", "global", "ezid", "mbr_version",
576
		     "metadata_url", "imagefile_url", "released",
577 578
		     "isdataset", "lba_size", "lba_low", "lba_high",
		     "origin_uuid", "origin_urn", "origin_name") {
579 580 581 582 583 584 585 586 587 588 589 590 591 592
	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.
593
    # We lock the os_info tables too, for the call into Lookup.
594
    #
595 596 597
    DBQueryWarn("lock tables images write, image_versions write, ".
		"            os_info as o read, os_info_versions as v read, ".
		"            emulab_indicies write")
598 599 600 601 602 603 604 605 606 607 608
	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;
    }
609 610 611 612 613 614
    # 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 =
615 616
	    DBQueryWarn("select imagename from image_versions ".
			"where metadata_url=$safe_url and deleted is null");
617 618 619 620 621 622 623

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

625 626
    # 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.
627
    if (defined($imageid) && $imageid > 0 ) {
628 629 630 631 632 633 634 635 636 637
	# 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.
	# 
638
	$imageid  = TBGetUniqueIndex("next_osid", undef, 1);
639
    }
640 641 642 643 644 645 646
    #
    # 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();
    #
647 648
    # Some fields special cause of quoting.
    #
649
    my $desc  = "''";
650 651 652 653
    if (exists($argref->{'description'})) {
	$desc = DBQuoteSpecial($argref->{'description'});
    }
    
654 655 656 657
    my $bquery = "imagename='$imagename'";
    $bquery .= ",imageid='$imageid'";
    $bquery .= ",pid='$pid',pid_idx='$pid_idx'";
    $bquery .= ",gid='$gid',gid_idx='$gid_idx'";
658

659 660 661
    my $query = "insert into image_versions set $bquery, ".
	join(",", map("$_='" . $argref->{$_} . "'", @arg_slots));
    
662
    $query .= ",creator='$uid',creator_idx='$uid_idx'";
663
    $query .= ",uuid='$version_uuid'";
664
    $query .= ",created=now()";
665 666
    $query .= ",description=$desc";
    $query .= ",hash=" . DBQuoteSpecial($argref->{'hash'})
667 668 669
	if (exists($argref->{'hash'}) && $argref->{'hash'} ne '');
    $query .= ",deltahash=" . DBQuoteSpecial($argref->{'deltahash'})
	if (exists($argref->{'deltahash'}) && $argref->{'deltahash'} ne '');
670 671 672 673 674 675
    $query .= ",size=" . DBQuoteSpecial($argref->{'size'})
	if (exists($argref->{'size'}));
    $query .= ",deltasize=" . DBQuoteSpecial($argref->{'deltasize'})
	if (exists($argref->{'deltasize'}));
    $query .= ",notes=" . DBQuoteSpecial($argref->{'notes'})
	if (exists($argref->{'notes'}) && $argref->{'notes'} ne '');
676 677 678 679 680 681

    #
    # 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.
    #
682 683
    if (exists($ENV{'REALGENIURN'}) && $ENV{'REALGENIURN'} ne "") {
	$query .= ",creator_urn=". DBQuoteSpecial($ENV{'REALGENIURN'});
684
    }
685 686

    # Create the main entry:
687
    if (! DBQueryWarn("insert into images set $bquery,uuid='$image_uuid'")) {
688 689 690 691 692
	DBQueryWarn("unlock tables");
	tberror("Error inserting new images record for $pid/$imagename!");
	return undef;
    }
    # And the other entry.
693
    if (! DBQueryWarn($query)) {
694
	DBQueryWarn("delete from images where uuid='$image_uuid'");
695 696 697 698
	DBQueryWarn("unlock tables");
	tberror("Error inserting new images record for $pid/$imagename!");
	return undef;
    }
699
    DBQueryWarn("unlock tables");
700 701 702 703 704

    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";
705
    if (!$isdataset && (!$isadmin || $makedefault)) {
706
	#
707 708 709
	# 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.
710
	#
711 712 713 714 715
	my @map_updates = ();
	foreach my $key (grep(/^mtype_/, keys(%{$argref}))) {
	    if ($argref->{$key} eq "1") {
		$key =~ s/^mtype_//;
		push(@map_updates, $key);
716 717 718
	    }
	}

719
	my @osid_array = ();
720
	for (my $i = 1; $i <= 4; $i++) {
721 722
	    my $func = "part${i}_osid";
	    my $foo  = $image->$func();
723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744
	    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;
		 }
	    }
	}
    }
745 746 747 748 749 750
    return $image;
}

#
# Clone an image descriptor from the DB, bumping the version number
#
751 752
# XXX A lot of stuff in here gets skipped for datasets.
#
753
sub NewVersion($$$$)
754
{
755
    my ($self, $creator, $baseimage, $usrerr_ref) = @_;
756 757
    my $osid        = $self->imageid();
    my $version     = $self->version();
758
    my $isdataset   = $self->isdataset();
759
    my $tableid     = int(rand(10000000));
760
    my $typelist    = "";
761 762 763 764 765 766 767 768
    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, ".
769
		"            emulab_indicies write, osidtoimageid read")
770 771 772 773 774 775 776 777 778
	or return undef;

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

779 780 781 782 783 784 785 786 787 788 789 790 791 792
    if (!$isdataset) {
	$query_result =
	    DBQueryWarn("create temporary table $ostablename ".
			"select * from os_info_versions ".
			"  where osid='$osid' and vers='$version'");
	goto bad
	    if (!$query_result);

	#
	# Grab the current type list.
	#
	$query_result =
	    DBQueryWarn("select distinct type from osidtoimageid ".
			"where imageid='$osid'");
793
    
794 795
	goto bad
	    if (!$query_result);
796

797 798 799 800 801
	my @types = ();
	while (my ($type) = $query_result->fetchrow_array()) {
	    push(@types, $type);
	}
	$typelist = join(",", @types);
802

803 804 805 806 807 808 809 810
	#
	# 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'");
    }
811

812 813 814 815
    #
    # Now reset a few things in each table.
    #
    my $clone_vers  = $self->version() + 1;
816
    my $updater_urn = "";
817 818 819 820 821
    #
    # 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.
    #
822 823
    if (exists($ENV{'REALGENIURN'}) && $ENV{'REALGENIURN'} ne "") {
	$updater_urn = ",updater_urn=". DBQuoteSpecial($ENV{'REALGENIURN'});
824
    }
825

826 827 828 829 830
    #
    # Figure out which partition needs to be changed. EZ images only
    # at this time.
    #
    my $part_vers = "";
831 832 833 834 835 836 837
    if (!$isdataset) {
	for (my $i = 1; $i <= 4; $i++) {
	    my $func = "part${i}_osid";
	    if (defined($self->$func())) {
		$part_vers = "part${i}_vers='${clone_vers}',";
		last;
	    }
838 839 840 841 842 843 844 845 846
	}
    }
    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
847 848 849 850 851
    # 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.
852 853
    #
    my ($parent_imageid, $parent_version);
854 855 856 857

    if (!defined($baseimage)) {
	$parent_imageid = "NULL";
	$parent_version = "NULL";
858 859
    }
    else {
860 861 862 863 864 865 866 867 868 869
	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'";
870 871 872 873 874 875
    }

    #
    # Fix up the path by appending the version number.
    #
    my $path = $self->path();
876 877 878 879 880 881 882
    if (!$self->IsDirPath()) {
	if ($path =~ /^(.*):\d+$/) {
	    $path = $1 . ":${clone_vers}";
	}
	else {
	    $path .= ":${clone_vers}";
	}
883
    }
884 885 886 887 888 889 890 891 892 893
    
    if (!$isdataset) {
	DBQueryWarn("update $ostablename set ".
		    "  uuid=uuid(), ".
		    "  vers='$clone_vers',".
		    "  parent_osid=$parent_imageid,".
		    "  parent_vers=$parent_version ".
		    "where osid='$osid'")
	    or goto bad;
    }
894
    DBQueryWarn("update $imtablename set ".
Leigh B Stoller's avatar
Leigh B Stoller committed
895
		"  uuid=uuid(),ready=0,path='$path',released=0, ".
896 897
		"  $part_vers default_vers='$clone_vers', ".
		"  version='$clone_vers',last_used=NULL, ".
898
		"  created=now(),nodetypes='$typelist', ".
899 900
		"  parent_imageid=$parent_imageid,".
		"  parent_version=$parent_version, ".
901 902
		"  origin_neednotify=0,origin_needupdate=0, ".
		"  origin_uuid=NULL,origin_name=NULL, ".
903
		"  hash=null,deltahash=null,size=0,deltasize=0, ".
904
		"  updater='$uid',updater_idx='$uid_idx' $updater_urn ".
905 906 907 908 909
		"where imageid='$osid'")
	or goto bad;

    #
    # And insert into the real table. At this point we will be
910
    # inconsistent if we crash before the commit is done.
911
    #
912 913 914 915 916 917 918
    if (!$isdataset) {
	DBQueryWarn("insert into os_info_versions ".
		    "select * from $ostablename")
	    or goto bad;
    }
    if (! DBQueryWarn("insert into image_versions ".
		      "select * from $imtablename")) {
919
	DBQueryWarn("delete from os_info_versions ".
920 921
		    "where osid='$osid' and vers='$clone_vers'")
	    if (!$isdataset);
922 923 924 925 926 927
	DBQueryWarn("delete from image_versions ".
		    "where imageid='$osid' and version='$clone_vers'");
	goto bad;
    }
    
    DBQueryWarn("unlock tables");
928
    return Image->Lookup($osid, $clone_vers);
929
  bad:
930
    DBQueryWarn("unlock tables");
931 932
    return undef;
}
933

934 935 936 937 938 939 940 941 942 943 944 945 946 947 948
#
# 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;
949 950
}

951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970
#
# 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);
}

971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997
#
# 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;
}

998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 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
#
# 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;
}

1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065
#
# 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;
1066
    foreach my $col ("description", "path", "mbr_version", "hash", "notes") {
1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079
	# 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 =
1080
	DBQueryWarn("select distinct n.type from nodes as n ".
1081 1082 1083 1084 1085 1086 1087 1088
		     "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);
1089 1090 1091 1092 1093
    }
    #
    # Special hack to allow pcvm type -- see SetupReload in os_setup
    #
    push @mtypes_array, "pcvm";
1094

1095
    foreach my $type (@mtypes_array) {
1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119
	# 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) {
1120
	DBQueryWarn("lock tables images write, image_versions write, ".
Leigh B Stoller's avatar
Leigh B Stoller committed
1121
		    "     images as i write, image_versions as v write, ".
1122 1123
		    "     os_info write, os_info_versions write, ".
		    "     osidtoimageid write");
1124 1125 1126 1127
    }
    if (keys %updates) {
	if ($image->Update(\%updates)) {
	    $$usrerr_ref = "DB: Error updating the images table";
1128
	    DBQueryWarn("unlock tables");
1129 1130 1131 1132 1133 1134 1135 1136
	    return undef;
	}
    }
    if ($redo_map) {
	#
	# Update the osidtoimageid table too.
	# 
	# Must delete old entries first.
1137
	DBQueryWarn("delete from osidtoimageid ".
1138 1139 1140 1141
		     "where imageid='$imageid'");

	my @osid_array;
	for (my $i = 1; $i <= 4; $i++) {
1142 1143
	    my $func = "part${i}_osid";
	    my $foo  = $image->$func();
1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155
	    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";
1156
		 DBQueryWarn($query);
1157 1158 1159 1160
	    }
	}
    }
    if (keys %updates || $redo_map) {
1161
	DBQueryWarn("unlock tables");
1162 1163 1164 1165 1166
    }

    return 1;
}

1167 1168 1169 1170 1171 1172 1173 1174 1175
#
# Stringify for output.
#
sub Stringify($)
{
    my ($self) = @_;
    
    my $pid       = $self->pid();
    my $imageid   = $self->imageid();
1176
    my $version   = $self->version();
1177 1178
    my $imagename = $self->imagename();

1179
    return "[Image $imageid:$version $pid,$imagename]";
1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197
}

#
# 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 ...
#
1198
sub Update($;$)
1199
{
1200 1201 1202
    my ($self, $argref, $allvers) = @_;
    $allvers = 0
	if (!defined($allvers));
1203 1204 1205 1206 1207 1208

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

    my $imageid = $self->imageid();
1209
    my $version = $self->version();
1210

1211 1212
    my $query = 
	join(",", map("$_=" . DBQuoteSpecial($argref->{$_}), keys(%{$argref})));
1213

1214 1215
    $query .= " where imageid='$imageid'";
    $query .= " and version='$version'" if (!$allvers);
1216 1217

    return -1
1218 1219
	if (! DBQueryWarn("update image_versions set $query"));
	    
1220 1221 1222
    return Refresh($self);
}

1223
#
1224
# Delete an image,
1225
#
1226
sub Delete($;$)
1227
{
1228
    my ($self, $purge) = @_;
1229 1230 1231 1232 1233

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

1234 1235 1236 1237
    $purge = 0
	if (!defined($purge));
    
    my $imageid   = $self->imageid();
1238
    my $uuid      = $self->image_uuid();
1239

1240 1241 1242
    DBQueryWarn("lock tables images write, image_versions write, ".
		"            os_info write, os_info_versions write, ".
		"            osidtoimageid write, os_submap write, ".
1243
		"            image_permissions write, node_types read, ".
Leigh B Stoller's avatar
Leigh B Stoller committed
1244 1245 1246
		"            web_tasks write, ".
		"            image_notifications write, ".
		"            image_updates write")
1247 1248
	or return -1;

1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261
    #
    # 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'")
	}
    }

1262 1263 1264 1265 1266 1267 1268
    #
    # 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;
1269 1270
    DBQueryWarn("delete from web_tasks where object_uuid='$uuid'")
	or goto bad;
1271 1272 1273 1274
    DBQueryWarn("delete from image_notifications where imageid='$imageid'")
	or goto bad;
    DBQueryWarn("delete from image_updates where imageid='$imageid'")
	or goto bad;
1275
    
1276
    if ($purge || !$DOPROVENANCE) {
1277
	goto bad
Leigh B Stoller's avatar
Leigh B Stoller committed
1278 1279
	    if (! DBQueryWarn("delete from image_versions ".
			      "where imageid='$imageid'"));
1280 1281 1282
    }
    else {
	# Set deleted on all of the versions.
1283
	DBQueryWarn("update image_versions set deleted=now() ".
1284 1285 1286
		    "where imageid='$imageid'")
	    or goto bad;
    }
1287
    if ($self->ezid()) {
1288 1289 1290
	# Cannot be a child or parent if I be dead.
	DBQueryWarn("delete from os_submap where ".
		    "  osid='$imageid' or parent_osid='$imageid'")
1291
	    or goto bad;
1292 1293 1294 1295 1296 1297 1298 1299 1300
	# Ditto.
	DBQueryWarn("update os_info_versions set def_parentosid=null ".
		    "  where def_parentosid='$imageid' and deleted is null")
	    or goto bad;
	# Ditto
	DBQueryWarn("update os_info_versions set nextosid=null ".
		    "  where nextosid='$imageid' and deleted is null")
	    or goto bad;
	
1301 1302
	DBQueryWarn("delete from os_info where osid='$imageid'")
	    or goto bad;
1303
	if ($purge || !$DOPROVENANCE) {
1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315
	    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;
1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326
    }
    DBQueryWarn("unlock tables")
	or return -1;

    return 0;

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

1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342
#
# 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
1343
    # image_versions. Maybe later.
1344 1345
    #
    my $query_result =
1346 1347
	DBQueryWarn("select max(version) from image_versions ".
		    "where imageid='$imageid'");
1348
    goto bad
1349 1350 1351 1352
	if (!$query_result || !$query_result->numrows);

    my ($version) = $query_result->fetchrow_array();
    if ($version != $self->version()) {
1353 1354 1355 1356 1357 1358 1359 1360
	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 ".
1361
			   "where osid='$imageid' and vers='$version'")));
1362 1363 1364 1365 1366 1367 1368 1369 1370 1371

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

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

1372
#
1373 1374 1375 1376 1377
# Load the project object for an image
#
sub GetProject($)
{
    my ($self) = @_;
1378
    require Project;
1379 1380 1381 1382 1383 1384 1385 1386

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

    my $project = Project->Lookup($self->pid_idx());
    
    if (! defined($project)) {
1387
	print("*** WARNING: Could not lookup project object for $self!\n");
1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398
	return undef;
    }
    return $project;
}

#
# Load the group object for an image
#
sub GetGroup($)
{
    my ($self) = @_;
1399
    require Group;
1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416

    # 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.
1417 1418 1419 1420
#
sub AccessCheck($$$)
{
    my ($self, $user, $access_type) = @_;
1421
    require Group;
1422 1423

    # Must be a real reference. 
1424
    return 0
1425 1426
	if (! ref($self));

1427 1428 1429 1430
    if ($access_type < TB_IMAGEID_MIN || $access_type > TB_IMAGEID_MAX) {
	print "*** Invalid access type $access_type!\n";
	return 0;
    }
1431 1432 1433
    my $isadmin = ((defined($user) && $user->IsAdmin()) ||
		   ($UID == 0 || $UID eq "root") ? 1 : 0);
	
1434 1435
    # Admins and root do whatever they want.
    return 1
1436
	if ($isadmin);
1437

1438 1439 1440 1441 1442 1443 1444 1445 1446
    my $mintrust;
    
    #
    # Global ImageIDs can be read by anyone.
    #
    if ($self->global()) {
	if ($access_type == TB_IMAGEID_READINFO) {
	    return 1;
	}
1447 1448 1449
	if ($access_type == TB_IMAGEID_EXPORT && $isadmin) {
	    return 1;
	}
1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470
    }

    my $project = $self->GetProject();
    return 0
	if (!defined($project));
    my $group = $self->GetGroup();
    return 0
	if (!defined($group));

    #
    # Otherwise must have proper trust in the group
    #
    if ($access_type == TB_IMAGEID_READINFO) {
	$mintrust = PROJMEMBERTRUST_USER;
        #
        # Shared imageids are readable by anyone in the project.
        #
	if ($self->shared()) {
	    $group = $project->GetProjectGroup();
	}
    }
1471 1472 1473 1474 1475 1476 1477 1478 1479
    elsif ($access_type == TB_IMAGEID_EXPORT) {
	#
	# Owner or root in the project.
	#
	return 1
	    if ($user->uid_idx() == $self->creator_idx());

	$mintrust = PROJMEMBERTRUST_GROUPROOT;
    }
1480 1481 1482 1483 1484 1485 1486 1487 1488
    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.
    #
1489 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 1520 1521 1522 1523
    return 1
	if (TBMinTrust($group->Trust($user), $mintrust) ||
	    TBMinTrust($project->Trust($user), PROJMEMBERTRUST_GROUPROOT));

    # No point in looking further; never allowed.
    return 0
	if ($access_type == TB_IMAGEID_EXPORT);

    #
    # Look in the image permissions. First look for a user permission,
    # then look for a group permission.
    #
    my $uid_idx = $user->uid_idx();
    my $imageid = $self->imageid();
    
    my $query_result = 
	DBQueryWarn("select allow_write from image_permissions ".
		    "where imageid='$imageid' and ".
		    "      permission_type='user' and ".
		    "      permission_idx='$uid_idx'");
    return 0
	if (!$query_result);
    
    if ($query_result->numrows) {
	# READINFO is read-only access to the image and its contents.
	return 1
	    if ($access_type == TB_IMAGEID_READINFO());
	
	if ($access_type == TB_IMAGEID_ACCESS()) {
	    my ($allow_write) = $query_result->fetchrow_array();

	    return 1
		if ($allow_write);
	}
    }
1524
    my $trust_none = $Group::MemberShip::TRUSTSTRING_NONE;
1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546
    $query_result = 
	DBQueryFatal("select allow_write from group_membership as g ".
		     "left join image_permissions as p on ".
		     "     p.permission_type='group' and ".
		     "     p.permission_idx=g.gid_idx ".
		     "where g.uid_idx='$uid_idx' and ".
		     "      p.imageid='$imageid' and ".
		     "      trust!='$trust_none'");

    if ($query_result->numrows) {
	# READINFO is read-only access to the image and its contents.
	return 1
	    if ($access_type == TB_IMAGEID_READINFO());
	
	if ($access_type == TB_IMAGEID_ACCESS()) {
	    my ($allow_write) = $query_result->fetchrow_array();

	    return 1
		if ($allow_write);
	}
    }
    return 0;
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
#
# LockTables simply locks the given tables, and then refreshes the
# instance (thereby getting the data from the DB after the tables are locked).
#
sub LockTables($;$)
{
    my ($self, $spec) = @_;

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

    $spec = "images write"
	if (!defined($spec));
    
    DBQueryWarn("lock tables $spec")
	or return -1;
	
    return $self->Refresh();
}
sub UnLockTables($)
{
    my ($self) = @_;

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

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

1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594
#
# Get the disk offset at which the image will be loaded.
# For a "whole disk" (loadpart == 0) image, it is always 0.
# For a "partition" image, it depends on the MBR type of the image.
#
# Returns -1 if the offset could not be determined (e.g., unknown MBR).
#
sub GetDiskOffset($)
{
    my ($self) = @_;

    # XXX these should come out of the DB or not exist at all!
    my %mbr = (
1595 1596 1597
	"1" => [0,   63,  6281415, 12562830, 12819870],
	"2" => [0,   63, 12305853, 24611643, 26712000],
	"3" => [0, 2048, 33556480, 39847936, 46139392]
1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612
    );

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

    return -1
	if (! exists($mbr{$self->mbr_version()}));

    return -1
	if ($self->loadpart() > 4);

    return $mbr{$self->mbr_version()}[$self->loadpart()];
}

1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637
#
# Return updated time for image as a UNIX timestamp via the passed ref.
# Return 0 on success, non-zero otherwise.
#
sub GetUpdate($$)
{
    my ($self,$stampp) = @_;

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

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

    my $result =
	DBQueryWarn("select UNIX_TIMESTAMP(updated) from image_versions ".
		    "where imageid='$imageid' and version='$version'");
    if ($result && $result->numrows) {
	my ($stamp) = $result->fetchrow_array();
	$$stampp = $stamp;
	return 0;
    }
}

1638 1639 1640
#
# Mark the update time in the record,
#
1641
sub MarkUpdate($$;$)
1642
{
1643
    my ($self, $user, $stamp) = @_;
1644 1645 1646 1647 1648

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

1649
    my $imageid     = $self->imageid();
1650
    my $version     = $self->version();
1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662
    my $updater     = "";
    my $updater_idx = "";
    my $updater_urn = "";
    if (defined($user)) {
	$updater     = ", updater='" . $user->uid() . "'";
	$updater_idx = ", updater_idx='" . $user->uid_idx() . "'";
    }
    #
    # 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.
    #
1663 1664
    if (exists($ENV{'REALGENIURN'}) && $ENV{'REALGENIURN'} ne "") {
	$updater_urn = ", updater_urn=". DBQuoteSpecial($ENV{'REALGENIURN'});
1665 1666
    }
    
1667 1668 1669 1670 1671 1672 1673
    if (defined($stamp)) {
	$stamp="FROM_UNIXTIME($stamp)";
    }
    else {
	$stamp="now()";
    }

1674
    return -1
1675
	if (! DBQueryWarn("update image_versions set updated=$stamp " .
1676
			  "  $updater $updater_idx $updater_urn ".
1677
			  "where imageid='$imageid' and version='$version'"));
1678 1679 1680 1681

    return 0;
}

1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719
#
# Mark the IMS update time in the record,
#
sub MarkIMSReported($)
{
    my ($self) = @_;

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

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

    return -1
	if (! DBQueryWarn("update image_versions set ims_reported=now() " .
			  "where imageid='$imageid' and version='$version'"));

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

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

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

    return -1
	if (! DBQueryWarn("update image_versions set ims_reported=NULL " .
			  "where imageid='$imageid' and version='$version'"));

    return 0;
}

1720 1721 1722
#
# Set the hash.
#
1723
sub SetFullHash($$)
1724 1725 1726
{
    my ($self, $hash) = @_;

1727
    return $self->Update({"hash" => $hash});
1728
}
1729 1730 1731 1732 1733 1734
sub SetDeltaHash($$)
{
    my ($self, $hash) = @_;

    return $self->Update({"deltahash" => $hash});
}
1735

1736 1737 1738
#
# Set the size.
#
1739
sub SetFullSize($$)
1740 1741 1742
{
    my ($self, $size) = @_;

1743
    return $self->Update({"size" => $size});
1744
}
1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763
sub SetDeltaSize($$)
{
    my ($self, $size) = @_;

    return $self->Update({"deltasize" => $size});
}

sub SetUploaderPath($$)
{
    my ($self, $path) = @_;

    return $self->Update({"uploader_path" => $path});
}
sub ClearUploaderPath($)
{
    my ($self) = @_;

    return $self->Update({"uploader_path" => ''});
}
1764

1765 1766
#
# Set the sector range of an image.
1767
# Note that lba_size and reloc flag are left alone unless explicitly specified.
1768
#
1769
sub SetRange($$$;$$)
1770
{