Image.pm.in 45.5 KB
Newer Older
1
2
#!/usr/bin/perl -wT
#
Leigh B Stoller's avatar
Leigh B Stoller committed
3
# Copyright (c) 2007-2014 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 $PGENISUPPORT  = @PROTOGENI_SUPPORT@;
50
my $DOPROVENANCE  = @IMAGEPROVENANCE@;
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
my $TBWWW         = "@TBWWW@";

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

# Little helper and debug function.
sub mysystem($)
{
    my ($command) = @_;

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

67
68
69
70
71
72
73
74
75
76
77
78
sub BlessRow($$)
{
    my ($class, $row) = @_;
    
    my $self           = {};
    my $imageid        = $row->{"imageid"};
    $self->{'IMAGE'}   = $row;

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

79
#
80
81
# Lookup by idx or pid,imagename[:version] depending on the args. We always 
# return highest numbered version on this path, if no version specified.
82
#
83
sub Lookup($$;$$)
84
{
85
    my ($class, $arg1, $arg2, $arg3) = @_;
86
87

    #
88
89
    # A single arg is either an index or "pid,imagename[:version]" or
    # "pid/imagename[:version]" string.
90
91
92
    #
    if (!defined($arg2)) {
	if ($arg1 =~ /^(\d*)$/) {
93
	    my $result =
94
		DBQueryWarn("select v.* from images as i ".
95
96
97
98
99
100
101
			    "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());
102
103
	}
	elsif ($arg1 =~ /^([-\w]*),([-\w\.\+]*)$/ ||
104
105
		$arg1 =~ /^([-\w]*)\/([-\w\.\+]*)$/) {
	    my $result =
106
		DBQueryWarn("select v.* from images as i ".
107
108
109
110
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.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 =
118
		DBQueryWarn("select v.* from images as i ".
119
120
			    "left join image_versions as v on ".
			    "     v.imageid=i.imageid ".
121
122
			    "where i.pid='$1' and i.imagename='$2' and ".
			    "      v.version='$3' and v.deleted is null");
123
124
125
126
	    return undef
		if (!$result || !$result->numrows);

	    return BlessRow($class, $result->fetchrow_hashref())
127
	}
Leigh B Stoller's avatar
Leigh B Stoller committed
128
129
	elsif ($arg1 =~ /^\w+\-\w+\-\w+\-\w+\-\w+$/) {
	    my $result =
130
131
		DBQueryWarn("select * from image_versions ".
			    "where uuid='$arg1' and deleted is null");
Leigh B Stoller's avatar
Leigh B Stoller committed
132
133
134
135

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

136
	    return BlessRow($class, $result->fetchrow_hashref());
Leigh B Stoller's avatar
Leigh B Stoller committed
137
	}
138
139
	return undef;
    }
140
141
142
143
144
145
146
147
148
149
    elsif (!defined($arg3)) {
	if ($arg1 =~ /^\d+$/ && $arg2 =~ /^\d+$/) {
	    my $result =
		DBQueryWarn("select v.* from images as i ".
			    "left join image_versions as v on ".
			    "     v.imageid=i.imageid ".
			    "where i.imageid='$arg1' and v.version='$arg2' ".
			    " and  v.deleted is null");
	    return undef
		if (! $result || !$result->numrows);
150

151
152
153
154
155
156
157
158
159
160
161
	    return BlessRow($class, $result->fetchrow_hashref());
	}
	elsif ($arg1 =~ /^[-\w]*$/ && $arg2 =~ /^([-\w\.\+]*):(\d+)$/) {
	    my $result =
		DBQueryWarn("select v.* from images as i ".
			    "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);
162

163
164
165
166
	    return BlessRow($class, $result->fetchrow_hashref());
	}
	elsif ($arg1 =~ /^[-\w]*$/ && $arg2 =~ /^[-\w\.\+]*$/) {
	    my $result =
167
		DBQueryWarn("select v.* from images as i ".
168
169
170
171
172
			    "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);
173

174
175
176
	    return BlessRow($class, $result->fetchrow_hashref());
	}
	return undef;
177
    }
178
179
180
181
    else {
	if ($arg1 =~ /^[-\w]*$/ &&
	    $arg2 =~ /^[-\w\.\+]*$/ && $arg3 =~ /^\d+$/) {
	    my $result =
182
		DBQueryWarn("select v.* from images as i ".
183
184
185
186
187
188
			    "left join image_versions as v on ".
			    "     v.imageid=i.imageid ".
			    "where i.pid='$arg1' and i.imagename='$arg2' and ".
			    "      v.version='$arg3' and v.deleted is null");
	    return undef
		if (!$result || !$result->numrows);
189

190
191
192
193
	    return BlessRow($class, $result->fetchrow_hashref());
	}
    }
    return undef;
194
}
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224

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) = @_;

    return undef
225
	if (! ($url =~ /^(ftp|http|https):/));
226
227
228
229

    my $safe_url = DBQuoteSpecial($url);
    
    my $query_result =
230
231
	DBQueryWarn("select pid,imagename from image_versions ".
		    "where metadata_url=$safe_url and deleted is null");
232
233
234
    return undef
	if (!$query_result || !$query_result->numrows);

235
    my ($pid,$imagename) = $query_result->fetchrow_array();
236

237
238
    # Want latest version.
    return Image->Lookup($pid, $imagename);
239
}
240

241
242
243
244
245
246
247
248
249
250
#
# Lookup a "system" osid, meaning one in the emulab-ops project.
#
sub LookupByName($$)
{
    my ($class, $imagename) = @_;

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

251
252
#
# Get a list of all running frisbee images.
253
254
# XXX if this is actually used, it will have to be fixed; DB no longer
# tracks running frisbee daemons.
255
256
257
258
259
260
261
#
sub ActiveImages($)
{
    my ($class) = @_;
    my @result  = ();

    my $query_result =
262
263
	DBQueryWarn("select imageid,imageid_version from frisbee_blobs ".
		    "where frisbee_pid!=0");
264
265
266
    return undef
	if (!defined($query_result));

267
268
    while (my ($imageid,$version) = $query_result->fetchrow_array()) {
	my $image = Image->Lookup($imageid, $version);
269
270
271
272
273
274
275
276
277
	if (!defined($image)) {
	    print STDERR "*** Could not find DB object for image $imageid\n";
	    return undef;
	}
	push(@result, $image);
    }
    return \@result;
}

278
279
280
281
282
283
284
#
# 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($$$)
{
285
    my ($class, $format, $pid) = @_;
286
287
288
289
290
291
292
293
294
    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");
295
	$clause .= " i.pid='$1'";
296
297
298
    }

    my $query_result =
299
300
301
302
	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");
303
304
305
306
307
308
309
310
    if ($query_result) {
	while (my ($pid,$name) = $query_result->fetchrow_array()) {
	    push(@result, "$pid/$name");
	}
    }
    return @result;
}

311
312
313
314
315
316
317
318
319
320
321
#
# Refresh a class instance by reloading from the DB.
#
sub Refresh($)
{
    my ($self) = @_;

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

    my $imageid = $self->imageid();
322
    my $version = $self->version();
323
324
    
    my $query_result =
325
326
	DBQueryWarn("select * from image_versions ".
		    "where imageid=$imageid and version='$version'");
327
328
329
330
331
332
333
334
335

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

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

    return 0;
}

336
337
338
339
#
# Create a new os_info. This installs the new record in the DB,
# and returns an instance. There is some bookkeeping along the way.
#
340
sub Create($$$$$$$$)
341
{
342
343
    my ($class, $project, $group, $creator,
	$imagename, $imageid, $argref, $usrerr_ref) = @_;
344
    require OSinfo;
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363

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

    my $isadmin = $creator->IsAdmin();

    # 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.
    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);
    }
    # Pass-through optional slots, otherwise the DB default is used.
364
    foreach my $key ("path", "shared", "global", "ezid", "mbr_version",
365
		     "metadata_url", "imagefile_url", "released") {
366
367
368
369
370
371
372
373
374
375
376
377
378
379
	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.
380
    # We lock the os_info tables too, for the call into Lookup.
381
    #
382
383
384
    DBQueryWarn("lock tables images write, image_versions write, ".
		"            os_info as o read, os_info_versions as v read, ".
		"            emulab_indicies write")
385
386
387
388
389
390
391
392
393
394
395
	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;
    }
396
397
398
399
400
401
    # 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 =
402
403
	    DBQueryWarn("select imagename from image_versions ".
			"where metadata_url=$safe_url and deleted is null");
404
405
406
407
408
409
410

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

412
413
414
415
416
417
418
419
420
421
422
423
424
    # 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.
    if ($imageid > 0 ) {
	# 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.
	# 
425
	$imageid  = TBGetUniqueIndex("next_osid", undef, 1);
426
    }
427
428
429
430
    my $uuid  = NewUUID();

    # Some fields special cause of quoting.
    #
431
    my $desc  = "''";
432
433
434
435
    if (exists($argref->{'description'})) {
	$desc = DBQuoteSpecial($argref->{'description'});
    }
    
436
437
438
439
440
    my $bquery = "imagename='$imagename'";
    $bquery .= ",imageid='$imageid'";
    $bquery .= ",uuid='$uuid'";
    $bquery .= ",pid='$pid',pid_idx='$pid_idx'";
    $bquery .= ",gid='$gid',gid_idx='$gid_idx'";
441

442
443
444
    my $query = "insert into image_versions set $bquery, ".
	join(",", map("$_='" . $argref->{$_} . "'", @arg_slots));
    
445
446
    $query .= ",creator='$uid',creator_idx='$uid_idx'";
    $query .= ",created=now()";
Leigh B Stoller's avatar
Leigh B Stoller committed
447
448
449
    $query .= ",description=$desc";
    $query .= ",hash=" . DBQuoteSpecial($argref->{'hash'})
	if (exists($argref->{'hash'}));
450
451
452
453
454
455
456
457
458

    #
    # 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'});
    }
459
460
461
462
463
464
465
466

    # Create the main entry:
    if (! DBQueryWarn("insert into images set $bquery")) {
	DBQueryWarn("unlock tables");
	tberror("Error inserting new images record for $pid/$imagename!");
	return undef;
    }
    # And the other entry.
467
468
469
470
471
    if (! DBQueryWarn($query)) {
	DBQueryWarn("unlock tables");
	tberror("Error inserting new images record for $pid/$imagename!");
	return undef;
    }
472
    DBQueryWarn("unlock tables");
473
474
475
476
477
478
479

    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";
    if (!$isadmin || $makedefault) {
	#
480
481
482
	# 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.
483
	#
484
485
486
487
488
	my @map_updates = ();
	foreach my $key (grep(/^mtype_/, keys(%{$argref}))) {
	    if ($argref->{$key} eq "1") {
		$key =~ s/^mtype_//;
		push(@map_updates, $key);
489
490
491
	    }
	}

492
	my @osid_array = ();
493
	for (my $i = 1; $i <= 4; $i++) {
494
495
	    my $func = "part${i}_osid";
	    my $foo  = $image->$func();
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
	    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;
		 }
	    }
	}
    }
518
519
520
521
522
523
    return $image;
}

#
# Clone an image descriptor from the DB, bumping the version number
#
524
sub NewVersion($$$$)
525
{
526
    my ($self, $creator, $baseimage, $usrerr_ref) = @_;
527
528
529
    my $osid        = $self->imageid();
    my $version     = $self->version();
    my $tableid     = int(rand(10000000));
530
    my $typelist    = "";
531
532
533
534
535
536
537
538
    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, ".
539
		"            emulab_indicies write, osidtoimageid read")
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
	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);

556
557
558
559
560
561
562
563
564
565
    #
    # 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
566
567
568
    my @types = ();
    while (my ($type) = $query_result->fetchrow_array()) {
	push(@types, $type);
569
    }
Leigh B Stoller's avatar
Leigh B Stoller committed
570
    $typelist = join(",", @types);
571

572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
    #
    # Now reset a few things in each table.
    #
    my $clone_vers  = $self->version() + 1;
    my $creator_urn = "";
    #
    # 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 "") {
	$creator_urn = ",creator_urn=". DBQuoteSpecial($ENV{'GENIURN'});
    }
    #
    # 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
    # bump the version number, but the parent pointers are different. 
    #
    my ($parent_imageid, $parent_version);
    
    if ($self->imageid() == $baseimage->imageid()) {
	$parent_imageid = $self->imageid();
	$parent_version = $self->version();
    }
    else {
	$parent_imageid = $baseimage->imageid();
	$parent_version = $baseimage->version();
    }

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

629
630
631
632
633
634
635
636
637
638
    DBQueryWarn("update $ostablename set ".
		"  uuid=uuid(), ".
		"  vers='$clone_vers',".
		"  parent_osid='$parent_imageid',".
		"  parent_vers='$parent_version', ".
		"  creator='$uid',creator_idx='$uid_idx' ".
		"where osid='$osid'")
	or goto bad;

    DBQueryWarn("update $imtablename set ".
Leigh B Stoller's avatar
Leigh B Stoller committed
639
		"  uuid=uuid(),ready=0,path='$path',released=0, ".
640
641
		"  $part_vers, default_vers='$clone_vers', ".
		"  version='$clone_vers',".
642
		"  created=now(),nodetypes='$typelist', ".
643
644
645
646
647
648
649
650
		"  parent_imageid='$parent_imageid',".
		"  parent_version='$parent_version', ".
		"  creator='$uid',creator_idx='$uid_idx' $creator_urn ".
		"where imageid='$osid'")
	or goto bad;

    #
    # And insert into the real table. At this point we will be
651
    # inconsistent if we crash before the commit is done.
652
653
654
655
    #
    if (! (DBQueryWarn("insert into os_info_versions ".
		       "select * from $ostablename") &&
	   DBQueryWarn("insert into image_versions ".
656
		       "select * from $imtablename"))) {
657
658
659
660
661
662
663
664
	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");
665
    return Image->Lookup($osid, $clone_vers);
666
  bad:
667
    DBQueryWarn("unlock tables");
668
669
    return undef;
}
670

671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
#
# 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;
686
687
}

688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
#
# 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);
}

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

758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
#
# 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;
Leigh B Stoller's avatar
Leigh B Stoller committed
776
    foreach my $col ("description", "path", "mbr_version", "hash") {
777
778
779
780
781
782
783
784
785
786
787
788
789
	# 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 =
790
	DBQueryWarn("select distinct n.type from nodes as n ".
791
792
793
794
795
796
797
798
		     "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);
799
800
801
802
803
    }
    #
    # Special hack to allow pcvm type -- see SetupReload in os_setup
    #
    push @mtypes_array, "pcvm";
804

805
    foreach my $type (@mtypes_array) {
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
	# 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) {
830
831
832
	DBQueryWarn("lock tables images write, image_versions write, ".
		    "     os_info write, os_info_versions write, ".
		    "     osidtoimageid write");
833
834
835
836
    }
    if (keys %updates) {
	if ($image->Update(\%updates)) {
	    $$usrerr_ref = "DB: Error updating the images table";
837
	    DBQueryWarn("unlock tables");
838
839
840
841
842
843
844
845
	    return undef;
	}
    }
    if ($redo_map) {
	#
	# Update the osidtoimageid table too.
	# 
	# Must delete old entries first.
846
	DBQueryWarn("delete from osidtoimageid ".
847
848
849
850
		     "where imageid='$imageid'");

	my @osid_array;
	for (my $i = 1; $i <= 4; $i++) {
851
852
	    my $func = "part${i}_osid";
	    my $foo  = $image->$func();
853
854
855
856
857
858
859
860
861
862
863
864
	    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";
865
		 DBQueryWarn($query);
866
867
868
869
	    }
	}
    }
    if (keys %updates || $redo_map) {
870
	DBQueryWarn("unlock tables");
871
872
873
874
875
    }

    return 1;
}

876
877
878
879
880
881
882
883
884
#
# Stringify for output.
#
sub Stringify($)
{
    my ($self) = @_;
    
    my $pid       = $self->pid();
    my $imageid   = $self->imageid();
885
    my $version   = $self->version();
886
887
    my $imagename = $self->imagename();

888
    return "[Image $imageid:$version $pid,$imagename]";
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
}

#
# 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();
916
    my $version = $self->version();
917

918
919
    my $query = 
	join(",", map("$_=" . DBQuoteSpecial($argref->{$_}), keys(%{$argref})));
920

921
    $query .= " where imageid='$imageid' and version='$version'";
922
923

    return -1
924
925
	if (! DBQueryWarn("update image_versions set $query"));
	    
926
927
928
    return Refresh($self);
}

929
#
930
# Delete an image,
931
#
932
sub Delete($;$)
933
{
934
    my ($self, $purge) = @_;
935
936
937
938
939

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

940
941
942
943
    $purge = 0
	if (!defined($purge));
    
    my $imageid   = $self->imageid();
944

945
946
947
948
    DBQueryWarn("lock tables images write, image_versions write, ".
		"            os_info write, os_info_versions write, ".
		"            osidtoimageid write, os_submap write, ".
		"            image_permissions write")
949
950
951
952
953
954
955
956
957
	or return -1;

    #
    # 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;
958
    
959
    if ($purge || !$DOPROVENANCE) {
960
961
962
963
964
965
966
967
968
969
970
	goto bad
	    if (! QueryWarn("delete from image_versions ".
			    "where imageid='$imageid'"));
    }
    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;
    }
971
972
973
974
975
    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;
976
	if ($purge || !$DOPROVENANCE) {
977
978
979
980
981
982
983
984
985
986
987
988
	    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;
989
990
991
992
993
994
995
996
997
998
999
    }
    DBQueryWarn("unlock tables")
	or return -1;

    return 0;

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

1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
#
# 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
1016
    # image_versions. Maybe later.
1017
1018
    #
    my $query_result =
1019
1020
	DBQueryWarn("select max(version) from image_versions ".
		    "where imageid='$imageid'");
1021
    goto bad
1022
1023
1024
1025
	if (!$query_result || !$query_result->numrows);

    my ($version) = $query_result->fetchrow_array();
    if ($version != $self->version()) {
1026
1027
1028
1029
1030
1031
1032
1033
	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 ".
1034
			   "where osid='$imageid' and vers='$version'")));
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044

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

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

1045
#
1046
1047
1048
1049
1050
# Load the project object for an image
#
sub GetProject($)
{
    my ($self) = @_;
1051
    require Project;
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071

    # 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) = @_;
1072
    require Group;
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089

    # 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.
1090
1091
1092
1093
#
sub AccessCheck($$$)
{
    my ($self, $user, $access_type) = @_;
1094
    require Group;
1095
1096

    # Must be a real reference. 
1097
    return 0
1098
1099
	if (! ref($self));

1100
1101
1102
1103
    if ($access_type < TB_IMAGEID_MIN || $access_type > TB_IMAGEID_MAX) {
	print "*** Invalid access type $access_type!\n";
	return 0;
    }
1104
1105
1106
    my $isadmin = ((defined($user) && $user->IsAdmin()) ||
		   ($UID == 0 || $UID eq "root") ? 1 : 0);
	
1107
1108
    # Admins and root do whatever they want.
    return 1
1109
	if ($isadmin);
1110

1111
1112
1113
1114
1115
1116
1117
1118
1119
    my $mintrust;
    
    #
    # Global ImageIDs can be read by anyone.
    #
    if ($self->global()) {
	if ($access_type == TB_IMAGEID_READINFO) {
	    return 1;
	}
1120
1121
1122
	if ($access_type == TB_IMAGEID_EXPORT && $isadmin) {
	    return 1;
	}
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
    }

    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();
	}
    }
1144
1145
1146
1147
1148
1149
1150
1151
1152
    elsif ($access_type == TB_IMAGEID_EXPORT) {
	#
	# Owner or root in the project.
	#
	return 1
	    if ($user->uid_idx() == $self->creator_idx());

	$mintrust = PROJMEMBERTRUST_GROUPROOT;
    }
1153
1154
1155
1156
1157
1158
1159
1160
1161
    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.
    #
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
    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);
	}
    }
1197
    my $trust_none = $Group::MemberShip::TRUSTSTRING_NONE;
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
    $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;
1220
1221
}

1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
#
# 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;
}

1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
#
# 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();

1269
1270
    my $result = DBQueryWarn("select UNIX_TIMESTAMP(updated) ".
			     "  from image_versions ".
1271
1272
1273
1274
1275
1276
1277
1278
			     "where imageid='$imageid'");
    if ($result && $result->numrows) {
	my ($stamp) = $result->fetchrow_array();
	$$stampp = $stamp;
	return 0;
    }
}

1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
#
# 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 = (
1292
1293
1294
	"1" => [0,   63,  6281415, 12562830, 12819870],
	"2" => [0,   63, 12305853, 24611643, 26712000],
	"3" => [0, 2048, 33556480, 39847936, 46139392]
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
    );

    # 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()];
}

1310
1311
1312
#
# Mark the update time in the record,
#
1313
sub MarkUpdate($$;$)
1314
{
1315
    my ($self, $user, $stamp) = @_;
1316
1317
1318
1319
1320

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

1321
    my $imageid     = $self->imageid();
1322
    my $version     = $self->version();
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
    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.
    #
    if (exists($ENV{'GENIURN'}) && $ENV{'GENIURN'} ne "") {
	$updater_urn = ", updater_urn=". DBQuoteSpecial($ENV{'GENIURN'});
    }
    
1339
1340
1341
1342
1343
1344
1345
    if (defined($stamp)) {
	$stamp="FROM_UNIXTIME($stamp)";
    }
    else {
	$stamp="now()";
    }

1346
    return -1
1347
	if (! DBQueryWarn("update image_versions set updated=$stamp " .
1348
			  "  $updater $updater_idx $updater_urn ".
1349
			  "where imageid='$imageid' and version='$version'"));
1350
1351
1352
1353

    return 0;
}

Leigh B Stoller's avatar
Leigh B Stoller committed
1354
1355
1356
1357
1358
1359
1360
#
# Set the hash.
#
sub SetHash($$)
{
    my ($self, $hash) = @_;

1361
    return $self->Update({"hash" => $hash});
Leigh B Stoller's avatar
Leigh B Stoller committed
1362
1363
}

1364
1365
1366
1367
1368
1369
1370
#
# Set the size.
#
sub SetSize($$)
{
    my ($self, $size) = @_;

1371
    return $self->Update({"size" => $size});
1372
1373
}

1374
1375
#
# Set the sector range of an image.
1376
# Note that lba_size and reloc flag are left alone unless explicitly specified.
1377
#
1378
sub SetRange($$$;$$)
1379
{
1380
    my ($self,$start,$end,$ssize,$isreloc) = @_;
1381

1382
    my $argref = {"lba_low" => $start, "lba_high" => $end};
1383

1384
    if (defined($ssize)) {
1385
	$argref->{'lba_size'} = $ssize;
1386
1387
    }
    if (defined($isreloc)) {
1388
	$argref->{'relocatable'} = $isreloc;
1389
    }
1390
    return $self->Update($argref);
1391
1392
}

1393
#
1394
1395
# Lock and Unlock. We lock the entire chain (all versions) of the
# image. 
1396
#
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
sub Lock($)
{
    my ($self) = @_;

    return -1
	if (! ref($self));
    return -1
	if (!DBQueryWarn("lock tables images write"));

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

    my $query_result =
1409
	DBQueryWarn("update images set locked=now(),locker_pid=$PID " .
1410
1411
1412
1413
1414
1415
1416
1417
1418
		    "where imageid='$imageid' and locked is null");

    if (! $query_result ||
	$query_result->numrows == 0) {
	DBQueryWarn("unlock tables");
	return -1;
    }
    DBQueryWarn("unlock tables");
    $self->{'IMAGE'}->{'locked'} = time();
1419
    $self->{'IMAGE'}->{'locker_pid'} = $PID;
1420
1421
1422
1423
    return 0;
}

sub Unlock($)
1424
1425
{
    my ($self) = @_;
1426
1427
1428
1429
1430

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

1431
    my $imageid = $self->imageid();
1432
1433

    return -1
1434
	if (! DBQueryWarn("update images set locked=null,locker_pid=0 " .
1435
			  "where imageid='$imageid'"));
1436
	    
1437
    $self->{'IMAGE'}->{'locked'} = 0;
1438
    $self->{'IMAGE'}->{'locker_pid'} = 0;
1439
1440
1441
    return 0;
}

1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
sub GotLock($)
{
    my ($self) = @_;

    return 1
	if ($self->{'IMAGE'}->{'locked'} &&
	    $self->{'IMAGE'}->{'locker_pid'} == $PID);
    
    return 0;
}

#
# Wait to get lock.
#
sub WaitLock($$)
{
    my ($self, $seconds) = @_;

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

    while ($seconds > 0) {
	return 0
	    if ($self->Lock() == 0);

	# Sleep and try again.
	sleep(5);
	$seconds -= 5;
    }
    # One last try.
    return $self->Lock();
}

1476
1477
1478
1479
1480
1481
#
# Get the type list.
#
sub TypeList($;$)
{
    my ($self, $osinfo) = @_;
1482
1483
1484
1485
    require NodeType;

    my @result  = ();
    my $imageid = $self->imageid();
1486
1487
    my $clause  = (defined($osinfo) ?
		   "and osid='" . $osinfo->osid() . "'" : "");
1488
1489
1490

    my $query_result =
	DBQueryWarn("select distinct type from osidtoimageid ".
1491
		    "where imageid='$imageid' $clause");
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
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
    return undef
	if (!defined($query_result));

    while (my ($type) = $query_result->fetchrow_array()) {
	my $typeinfo = NodeType->Lookup($type);
	push(@result, $typeinfo)
	    if (defined($typeinfo));
    }
    return @result;
}

#
# Grant/Revoke permission to access an image.
#
sub GrantAccess($$$)
{
    my ($self, $target, $writable) = @_;
    $writable = ($writable ? 1 : 0);

    my $imageid   = $self->imageid();
    my $imagename = $self->imagename();
    my ($perm_idx, $perm_id, $perm_type);

    if (ref($target) eq "User") {
	$perm_idx  = $target->uid_idx();
	$perm_id   = $target->uid();
	$perm_type = "user";
    }
    if (ref($target) eq "Group") {
	$perm_idx  = $target->gid_idx();
	$perm_id   = $target->pid() . "/" . $target->gid();
	$perm_type = "group";
    }

    return -1
	if (!DBQueryWarn("replace into image_permissions set ".
			 "  imageid='$imageid', imagename='$imagename', ".
			 "  permission_type='$perm_type', ".
			 "  permission_id='$perm_id', ".
			 "  permission_idx='$perm_idx', ".
			 "  allow_write='$writable'"));
    return 0;
}

sub RevokeAccess($$)
{
    my ($self, $target) = @_;

    my $imageid   = $self->imageid();
    my ($perm_idx, $perm_type);

    if (ref($target) eq "User") {
	$perm_idx  = $target->uid_idx();
	$perm_type = "user";
    }
    if (ref($target) eq "Group") {
	$perm_idx  = $target->gid_idx();
	$perm_type = "group";
    }

    return -1
	if (!DBQueryWarn("delete from image_permissions ".
			 "where imageid='$imageid' and ".
			 "  permission_type='$perm_type' and ".
			 "  permission_idx='$perm_idx'"));
    return 0;
}
1559

1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
#
# Class method to record image history info. 
#
sub RecordImageHistory($$$$$$)
{
    my ($class, $experiment, $action, $log_session, $impotent, $noderef) = @_;
    require Node;
    
    # Flush info; we want most recent.
    $experiment->Refresh();
    
    my $exptidx   = $experiment->idx();
    my $pid       = $experiment->pid();
    my $eid       = $experiment->eid();
    my $state     = $experiment->state();
    my $rsrcidx   = $experiment->rsrcidx();
    my $lastrsrc  = $experiment->lastrsrc();
    $log_session  = 'NULL' if (!defined($log_session));

    my %prev_alloc;
    my $cant_find_prev_alloc = 0;
    if ($state eq 'modify_reswap') {
	if (!defined($lastrsrc)) {
	    print STDERR "lastrsrc not set during swapmod\n";
	    return -1;
	}
	my $db_result =
	    DBQueryWarn("select node_id from image_history ".
			"where rsrcidx=$lastrsrc");
	return -1
	    if (!$db_result);
	
	if ($db_result->numrows() < 1) {
	    print STDERR "could not find previous state (rsrcidx=$lastrsrc) ".
		"in image_history table, won't be able to determine ".
		"newly allocated nodes\n";
	    $cant_find_prev_alloc = 1;
	}
	while (my $n = $db_result->fetchrow) {
	    $prev_alloc{$n} = 1;
	}
    }

    foreach my $node_id (keys(%{$noderef})) {
	my $node = Node->Lookup($node_id);
	if (! defined($node)) {
	    print STDERR "No DB record for $node_id\n";
	    next;
	}
	# Need uptodate info below.
	$node->FlushReserved();
	
	my $ref  = $noderef->{$node_id};
1613
	my ($osinfo, $image) = @{$ref};
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
	my $newly_alloc      = (exists($prev_alloc{$node_id}) ? 0 : 1);
	$newly_alloc = 'NULL'
	    if ($cant_find_prev_alloc);

	my $history_result =
	    DBQueryWarn("select max(history_id) ".
			"  from node_history where node_id = '$node_id'");
	return -1
	    if (! $history_result);

	if (! $history_result->numrows) {
	  nohistory:
	    print STDERR "No node_history for $node_id, ".
		"cannot log image usage for node.\n";
	    next;
	}
	my ($node_history_id) = $history_result->fetchrow_array();
	if (!defined($node_history_id)) {
	    goto nohistory;
	}
	my $vname      = $node->vname();
	my $erole      = $node->erole();
	my $phys_type  = $node->type();

	if (!defined($vname)) {
	    print STDERR "$node is no longer reserved!\n";
	    next;
	}

	# Ick. Should go into the Node object.
	my ($virt_result) =
	    DBQueryWarn("select osname,type from virt_nodes ".
			"where exptidx='$exptidx' and vname='$vname'");
	return -1
	    if (!$virt_result);
	if (!$virt_result->numrows) {
	    print STDERR "No virt info for node $node_id ($vname)\n";
	    next;
	}
	my ($osname, $req_type) = $virt_result->fetchrow_array();
	my $req_os = defined $osname ? ($osname ? 1 : 0) : 'NULL';
	$erole = 'delay' if $erole eq 'delaynode';
	$req_type = $erole unless defined $req_type;
1657
1658
1659
1660
	my $osid      = $osinfo->osid();
	my $osid_vers = $osinfo->vers();
	my $imageid   = $image->imageid();
	my $version   = $image->version();
1661
1662
1663
1664
1665
1666
1667

	next
	    if ($impotent);
	
	DBQueryWarn("insert into image_history ".
		    "(stamp, node_history_id, node_id, ".
		    " action, newly_alloc, rsrcidx, log_session, ".
1668
1669
		    " req_type, phys_type, req_os, ".
		    " osid, osid_vers, imageid, imageid_version) ".
1670
1671
1672
1673
		    "values(UNIX_TIMESTAMP(now()), ".
		    "       $node_history_id, '$node_id', '$action', ".
		    "       $newly_alloc, $rsrcidx, ".
		    "       $log_session, '$req_type', '$phys_type', ".
1674
		    "       $req_os, $osid, $osid_vers, $imageid, $version)")
1675
1676
1677
1678
1679
	    or return -1;
    }
    return 0;
}

1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694