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

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

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

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

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

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

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

    return $self->imageid() . ":" . $self->version();
}

66
67
68
69
70
71
72
73
74
75
# Little helper and debug function.
sub mysystem($)
{
    my ($command) = @_;

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

76
77
78
79
80
81
82
83
84
85
86
87
sub BlessRow($$)
{
    my ($class, $row) = @_;
    
    my $self           = {};
    my $imageid        = $row->{"imageid"};
    $self->{'IMAGE'}   = $row;

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

88
#
89
90
# Lookup by idx or pid,imagename[:version] depending on the args. We always 
# return highest numbered version on this path, if no version specified.
91
#
92
sub Lookup($$;$$)
93
{
94
    my ($class, $arg1, $arg2, $arg3) = @_;
95
96

    #
97
98
    # A single arg is either an index or "pid,imagename[:version]" or
    # "pid/imagename[:version]" string.
99
100
101
    #
    if (!defined($arg2)) {
	if ($arg1 =~ /^(\d*)$/) {
102
	    my $result =
103
104
		DBQueryWarn("select i.*,v.*,i.uuid as image_uuid ".
			    "  from images as i ".
105
106
107
108
109
110
111
			    "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());
112
	}
113
	elsif ($arg1 =~ /^(\d*):(\d*)$/) {
Leigh B Stoller's avatar
Leigh B Stoller committed
114
115
116
117
118
119
120
121
122
123
124
125
126
	    #
	    # This will get deleted images, but that is okay.
	    #
	    my $result =
		DBQueryWarn("select i.*,v.*,i.uuid as image_uuid ".
			    "  from image_versions as v ".
			    "left join images as i on ".
			    "     v.imageid=i.imageid ".
			    "where v.imageid='$1' and v.version='$2'");
	    return undef
		if (! $result || !$result->numrows);

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

	    return BlessRow($class, $result->fetchrow_hashref())
154
	}
Leigh B Stoller's avatar
Leigh B Stoller committed
155
	elsif ($arg1 =~ /^\w+\-\w+\-\w+\-\w+\-\w+$/) {
156
157
158
159
160
	    #
	    # 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
161
	    my $result =
162
163
164
165
166
167
168
169
170
		DBQueryWarn("select i.*,v.*,i.uuid as image_uuid ".
			    "  from images as i ".
			    "left join image_versions as v on ".
			    "     v.imageid=i.imageid and v.version=i.version ".
			    "where i.uuid='$arg1'");
	    return undef
		if (!$result);
	    return BlessRow($class, $result->fetchrow_hashref())
		if ($result->numrows);
Leigh B Stoller's avatar
Leigh B Stoller committed
171

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

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

200
201
202
203
	    return BlessRow($class, $result->fetchrow_hashref());
	}
	elsif ($arg1 =~ /^[-\w]*$/ && $arg2 =~ /^([-\w\.\+]*):(\d+)$/) {
	    my $result =
204
205
		DBQueryWarn("select i.*,v.*,i.uuid as image_uuid ".
			    "  from images as i ".
206
207
208
209
210
211
			    "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);
212

213
214
215
216
	    return BlessRow($class, $result->fetchrow_hashref());
	}
	elsif ($arg1 =~ /^[-\w]*$/ && $arg2 =~ /^[-\w\.\+]*$/) {
	    my $result =
217
218
		DBQueryWarn("select i.*,v.*,i.uuid as image_uuid ".
			    "  from images as i ".
219
220
221
222
223
			    "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);
224

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

242
243
244
245
	    return BlessRow($class, $result->fetchrow_hashref());
	}
    }
    return undef;
246
}
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274

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) = @_;
275
    my ($pid,$imagename);
276
277

    return undef
278
	if (! ($url =~ /^(ftp|http|https):/));
279
280
281
282

    my $safe_url = DBQuoteSpecial($url);
    
    my $query_result =
283
284
	DBQueryWarn("select pid,imagename from image_versions ".
		    "where metadata_url=$safe_url and deleted is null");
285
    return undef
286
	if (!$query_result);
287

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

	return Image->Lookup($uuid);
    }
    return undef;
315
}
316
317
318
319
320
321
322
# Image is local if the metadata_url is null.
sub IsLocal($)
{
    my ($self) = @_;

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

324
325
326
327
328
329
330
331
332
333
#
# Lookup a "system" osid, meaning one in the emulab-ops project.
#
sub LookupByName($$)
{
    my ($class, $imagename) = @_;

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

334
335
#
# Get a list of all running frisbee images.
336
337
# XXX if this is actually used, it will have to be fixed; DB no longer
# tracks running frisbee daemons.
338
339
340
341
342
343
344
#
sub ActiveImages($)
{
    my ($class) = @_;
    my @result  = ();

    my $query_result =
345
346
	DBQueryWarn("select imageid,imageid_version from frisbee_blobs ".
		    "where frisbee_pid!=0");
347
348
349
    return undef
	if (!defined($query_result));

350
351
    while (my ($imageid,$version) = $query_result->fetchrow_array()) {
	my $image = Image->Lookup($imageid, $version);
352
353
354
355
356
357
358
359
360
	if (!defined($image)) {
	    print STDERR "*** Could not find DB object for image $imageid\n";
	    return undef;
	}
	push(@result, $image);
    }
    return \@result;
}

361
362
363
364
365
366
367
#
# 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($$$)
{
368
    my ($class, $format, $pid) = @_;
369
370
371
372
373
374
375
376
377
    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");
378
	$clause .= " i.pid='$1'";
379
380
381
    }

    my $query_result =
382
383
384
385
	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");
386
387
388
389
390
391
392
393
    if ($query_result) {
	while (my ($pid,$name) = $query_result->fetchrow_array()) {
	    push(@result, "$pid/$name");
	}
    }
    return @result;
}

394
395
396
397
398
399
400
401
402
403
404
#
# Refresh a class instance by reloading from the DB.
#
sub Refresh($)
{
    my ($self) = @_;

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

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

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

    return 0;
}

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

    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.
449
    foreach my $key ("path", "shared", "global", "ezid", "mbr_version",
450
		     "metadata_url", "imagefile_url", "released") {
451
452
453
454
455
456
457
458
459
460
461
462
463
464
	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.
465
    # We lock the os_info tables too, for the call into Lookup.
466
    #
467
468
469
    DBQueryWarn("lock tables images write, image_versions write, ".
		"            os_info as o read, os_info_versions as v read, ".
		"            emulab_indicies write")
470
471
472
473
474
475
476
477
478
479
480
	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;
    }
481
482
483
484
485
486
    # 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 =
487
488
	    DBQueryWarn("select imagename from image_versions ".
			"where metadata_url=$safe_url and deleted is null");
489
490
491
492
493
494
495

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

497
498
499
500
501
502
503
504
505
506
507
508
509
    # We allow providing an image descriptor index, so newimageid_ez can use
    # the same name, description, and index for both the OS and Image it makes.
    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.
	# 
510
	$imageid  = TBGetUniqueIndex("next_osid", undef, 1);
511
    }
512
513
514
515
516
517
518
    #
    # 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();
    #
519
520
    # Some fields special cause of quoting.
    #
521
    my $desc  = "''";
522
523
524
525
    if (exists($argref->{'description'})) {
	$desc = DBQuoteSpecial($argref->{'description'});
    }
    
526
527
528
529
    my $bquery = "imagename='$imagename'";
    $bquery .= ",imageid='$imageid'";
    $bquery .= ",pid='$pid',pid_idx='$pid_idx'";
    $bquery .= ",gid='$gid',gid_idx='$gid_idx'";
530

531
532
533
    my $query = "insert into image_versions set $bquery, ".
	join(",", map("$_='" . $argref->{$_} . "'", @arg_slots));
    
534
    $query .= ",creator='$uid',creator_idx='$uid_idx'";
535
    $query .= ",uuid='$version_uuid'";
536
    $query .= ",created=now()";
Leigh B Stoller's avatar
Leigh B Stoller committed
537
538
539
    $query .= ",description=$desc";
    $query .= ",hash=" . DBQuoteSpecial($argref->{'hash'})
	if (exists($argref->{'hash'}));
540
541
542
543
544
545
546
547
548

    #
    # 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'});
    }
549
550

    # Create the main entry:
551
    if (! DBQueryWarn("insert into images set $bquery,uuid='$image_uuid'")) {
552
553
554
555
556
	DBQueryWarn("unlock tables");
	tberror("Error inserting new images record for $pid/$imagename!");
	return undef;
    }
    # And the other entry.
557
558
559
560
561
    if (! DBQueryWarn($query)) {
	DBQueryWarn("unlock tables");
	tberror("Error inserting new images record for $pid/$imagename!");
	return undef;
    }
562
    DBQueryWarn("unlock tables");
563
564
565
566
567
568
569

    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) {
	#
570
571
572
	# 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.
573
	#
574
575
576
577
578
	my @map_updates = ();
	foreach my $key (grep(/^mtype_/, keys(%{$argref}))) {
	    if ($argref->{$key} eq "1") {
		$key =~ s/^mtype_//;
		push(@map_updates, $key);
579
580
581
	    }
	}

582
	my @osid_array = ();
583
	for (my $i = 1; $i <= 4; $i++) {
584
585
	    my $func = "part${i}_osid";
	    my $foo  = $image->$func();
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
	    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;
		 }
	    }
	}
    }
608
609
610
611
612
613
    return $image;
}

#
# Clone an image descriptor from the DB, bumping the version number
#
614
sub NewVersion($$$$)
615
{
616
    my ($self, $creator, $baseimage, $usrerr_ref) = @_;
617
618
619
    my $osid        = $self->imageid();
    my $version     = $self->version();
    my $tableid     = int(rand(10000000));
620
    my $typelist    = "";
621
622
623
624
625
626
627
628
    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, ".
629
		"            emulab_indicies write, osidtoimageid read")
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
	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);

646
647
648
649
650
651
652
653
654
655
    #
    # 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
656
657
658
    my @types = ();
    while (my ($type) = $query_result->fetchrow_array()) {
	push(@types, $type);
659
    }
Leigh B Stoller's avatar
Leigh B Stoller committed
660
    $typelist = join(",", @types);
661

662
663
664
665
666
667
668
669
    #
    # 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'");

670
671
672
673
    #
    # Now reset a few things in each table.
    #
    my $clone_vers  = $self->version() + 1;
674
    my $updater_urn = "";
675
676
677
678
679
680
    #
    # 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 "") {
681
	$updater_urn = ",updater_urn=". DBQuoteSpecial($ENV{'GENIURN'});
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
    }
    #
    # 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
703
704
705
706
707
    # 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.
708
709
    #
    my ($parent_imageid, $parent_version);
710
711
712
713

    if (!defined($baseimage)) {
	$parent_imageid = "NULL";
	$parent_version = "NULL";
714
715
    }
    else {
716
717
718
719
720
721
722
723
724
725
	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'";
726
727
728
729
730
731
732
733
734
735
736
737
    }

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

739
740
741
    DBQueryWarn("update $ostablename set ".
		"  uuid=uuid(), ".
		"  vers='$clone_vers',".
742
743
		"  parent_osid=$parent_imageid,".
		"  parent_vers=$parent_version ".
744
745
746
747
		"where osid='$osid'")
	or goto bad;

    DBQueryWarn("update $imtablename set ".
Leigh B Stoller's avatar
Leigh B Stoller committed
748
		"  uuid=uuid(),ready=0,path='$path',released=0, ".
749
750
		"  $part_vers, default_vers='$clone_vers', ".
		"  version='$clone_vers',".
751
		"  created=now(),nodetypes='$typelist', ".
752
753
		"  parent_imageid=$parent_imageid,".
		"  parent_version=$parent_version, ".
754
		"  updater='$uid',updater_idx='$uid_idx' $updater_urn ".
755
756
757
758
759
		"where imageid='$osid'")
	or goto bad;

    #
    # And insert into the real table. At this point we will be
760
    # inconsistent if we crash before the commit is done.
761
762
763
764
    #
    if (! (DBQueryWarn("insert into os_info_versions ".
		       "select * from $ostablename") &&
	   DBQueryWarn("insert into image_versions ".
765
		       "select * from $imtablename"))) {
766
767
768
769
770
771
772
773
	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");
774
    return Image->Lookup($osid, $clone_vers);
775
  bad:
776
    DBQueryWarn("unlock tables");
777
778
    return undef;
}
779

780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
#
# 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;
795
796
}

797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
#
# 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);
}

817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
#
# 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;
}

844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
#
# 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;
}

894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
#
# 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;
912
    foreach my $col ("description", "path", "mbr_version", "hash", "notes") {
913
914
915
916
917
918
919
920
921
922
923
924
925
	# 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 =
926
	DBQueryWarn("select distinct n.type from nodes as n ".
927
928
929
930
931
932
933
934
		     "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);
935
936
937
938
939
    }
    #
    # Special hack to allow pcvm type -- see SetupReload in os_setup
    #
    push @mtypes_array, "pcvm";
940

941
    foreach my $type (@mtypes_array) {
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
	# 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) {
966
	DBQueryWarn("lock tables images write, image_versions write, ".
Leigh B Stoller's avatar
Leigh B Stoller committed
967
		    "     images as i write, image_versions as v write, ".
968
969
		    "     os_info write, os_info_versions write, ".
		    "     osidtoimageid write");
970
971
972
973
    }
    if (keys %updates) {
	if ($image->Update(\%updates)) {
	    $$usrerr_ref = "DB: Error updating the images table";
974
	    DBQueryWarn("unlock tables");
975
976
977
978
979
980
981
982
	    return undef;
	}
    }
    if ($redo_map) {
	#
	# Update the osidtoimageid table too.
	# 
	# Must delete old entries first.
983
	DBQueryWarn("delete from osidtoimageid ".
984
985
986
987
		     "where imageid='$imageid'");

	my @osid_array;
	for (my $i = 1; $i <= 4; $i++) {
988
989
	    my $func = "part${i}_osid";
	    my $foo  = $image->$func();
990
991
992
993
994
995
996
997
998
999
1000
1001
	    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";
1002
		 DBQueryWarn($query);
1003
1004
1005
1006
	    }
	}
    }
    if (keys %updates || $redo_map) {
1007
	DBQueryWarn("unlock tables");
1008
1009
1010
1011
1012
    }

    return 1;
}

1013
1014
1015
1016
1017
1018
1019
1020
1021
#
# Stringify for output.
#
sub Stringify($)
{
    my ($self) = @_;
    
    my $pid       = $self->pid();
    my $imageid   = $self->imageid();
1022
    my $version   = $self->version();
1023
1024
    my $imagename = $self->imagename();

1025
    return "[Image $imageid:$version $pid,$imagename]";
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
}

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

1055
1056
    my $query = 
	join(",", map("$_=" . DBQuoteSpecial($argref->{$_}), keys(%{$argref})));
1057

1058
    $query .= " where imageid='$imageid' and version='$version'";
1059
1060

    return -1
1061
1062
	if (! DBQueryWarn("update image_versions set $query"));
	    
1063
1064
1065
    return Refresh($self);
}

1066
#
1067
# Delete an image,
1068
#
1069
sub Delete($;$)
1070
{
1071
    my ($self, $purge) = @_;
1072
1073
1074
1075
1076

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

1077
1078
1079
1080
    $purge = 0
	if (!defined($purge));
    
    my $imageid   = $self->imageid();
1081

1082
1083
1084
    DBQueryWarn("lock tables images write, image_versions write, ".
		"            os_info write, os_info_versions write, ".
		"            osidtoimageid write, os_submap write, ".
1085
		"            image_permissions write, node_types read")
1086
1087
	or return -1;

1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
    #
    # 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'")
	}
    }

1101
1102
1103
1104
1105
1106
1107
    #
    # 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;
1108
    
1109
    if ($purge || !$DOPROVENANCE) {
1110
	goto bad
Leigh B Stoller's avatar
Leigh B Stoller committed
1111
1112
	    if (! DBQueryWarn("delete from image_versions ".
			      "where imageid='$imageid'"));
1113
1114
1115
1116
1117
1118
1119
1120
    }
    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;
    }
1121
1122
1123
1124
1125
    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;
1126
	if ($purge || !$DOPROVENANCE) {
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
	    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;
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
    }
    DBQueryWarn("unlock tables")
	or return -1;

    return 0;

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

1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
#
# 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
1166
    # image_versions. Maybe later.
1167
1168
    #
    my $query_result =
1169
1170
	DBQueryWarn("select max(version) from image_versions ".
		    "where imageid='$imageid'");
1171
    goto bad
1172
1173
1174
1175
	if (!$query_result || !$query_result->numrows);

    my ($version) = $query_result->fetchrow_array();
    if ($version != $self->version()) {
1176
1177
1178
1179
1180
1181
1182
1183
	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 ".
1184
			   "where osid='$imageid' and vers='$version'")));
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194

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

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

1195
#
1196
1197
1198
1199
1200
# Load the project object for an image
#
sub GetProject($)
{
    my ($self) = @_;
1201
    require Project;
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221

    # 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) = @_;
1222
    require Group;
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239

    # 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.
1240
1241
1242
1243
#
sub AccessCheck($$$)
{
    my ($self, $user, $access_type) = @_;
1244
    require Group;
1245
1246

    # Must be a real reference. 
1247
    return 0
1248
1249
	if (! ref($self));

1250
1251
1252
1253
    if ($access_type < TB_IMAGEID_MIN || $access_type > TB_IMAGEID_MAX) {
	print "*** Invalid access type $access_type!\n";
	return 0;
    }
1254
1255
1256
    my $isadmin = ((defined($user) && $user->IsAdmin()) ||
		   ($UID == 0 || $UID eq "root") ? 1 : 0);
	
1257
1258
    # Admins and root do whatever they want.
    return 1
1259
	if ($isadmin);
1260

1261
1262
1263
1264
1265
1266
1267
1268
1269
    my $mintrust;
    
    #
    # Global ImageIDs can be read by anyone.
    #
    if ($self->global()) {
	if ($access_type == TB_IMAGEID_READINFO) {
	    return 1;
	}
1270
1271
1272
	if ($access_type == TB_IMAGEID_EXPORT && $isadmin) {
	    return 1;
	}
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
    }

    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();
	}
    }
1294
1295
1296
1297
1298
1299
1300
1301
1302
    elsif ($access_type == TB_IMAGEID_EXPORT) {
	#
	# Owner or root in the project.
	#
	return 1
	    if ($user->uid_idx() == $self->creator_idx());

	$mintrust = PROJMEMBERTRUST_GROUPROOT;
    }
1303
1304
1305
1306
1307
1308
1309
1310
1311
    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.
    #
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
    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);
	}
    }
1347
    my $trust_none = $Group::MemberShip::TRUSTSTRING_NONE;
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
    $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;
1370
1371
}

1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
#
# 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;
}

1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
#
# 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();

1419
1420
    my $result = DBQueryWarn("select UNIX_TIMESTAMP(updated) ".
			     "  from image_versions ".
1421
1422
1423
1424
1425
1426
1427
1428
			     "where imageid='$imageid'");
    if ($result && $result->numrows) {
	my ($stamp) = $result->fetchrow_array();
	$$stampp = $stamp;
	return 0;
    }
}

1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
#
# 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 = (
1442
1443
1444
	"1" => [0,   63,  6281415, 12562830, 12819870],
	"2" => [0,   63, 12305853, 24611643, 26712000],
	"3" => [0, 2048, 33556480, 39847936, 46139392]
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
    );

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

1460
1461
1462
#
# Mark the update time in the record,
#
1463
sub MarkUpdate($$;$)
1464
{
1465
    my ($self, $user, $stamp) = @_;
1466
1467
1468
1469
1470

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

1471
    my $imageid     = $self->imageid();
1472
    my $version     = $self->version();
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
    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'});
    }
    
1489
1490
1491
1492
1493
1494
1495
    if (defined($stamp)) {
	$stamp="FROM_UNIXTIME($stamp)";
    }
    else {
	$stamp="now()";
    }

1496
    return -1
1497
	if (! DBQueryWarn("update image_versions set updated=$stamp " .
1498
			  "  $updater $updater_idx $updater_urn ".
1499
			  "where imageid='$imageid' and version='$version'"));
1500
1501
1502
1503

    return 0;
}

Leigh B Stoller's avatar
Leigh B Stoller committed
1504
1505
1506
1507
1508
1509
1510
#
# Set the hash.
#
sub SetHash($$)
{
    my ($self, $hash) = @_;

1511
    return $self->Update({"hash" => $hash});
Leigh B Stoller's avatar
Leigh B Stoller committed
1512
1513
}

1514
1515
1516
1517
1518
1519
1520
#
# Set the size.
#
sub SetSize($$)
{
    my ($self, $size) = @_;

1521
    return $self->Update({"size" => $size});
1522
1523
}

1524
1525
#
# Set the sector range of an image.
1526
# Note that lba_size and reloc flag are left alone unless explicitly specified.
1527
#
1528
sub SetRange($$$;$$)
1529
{
1530
    my ($self,$start,$end,$ssize,$isreloc) = @_;
1531

1532
    my $argref = {"lba_low" => $start, "lba_high" => $end};
1533

1534
    if (defined($ssize)) {
1535
	$argref->{'lba_size'} = $ssize;
1536
1537
    }
    if (defined($isreloc)) {
1538
	$argref->{'relocatable'} = $isreloc;
1539
    }
1540
    return $self->Update($argref);
1541
1542
}

1543
#
1544
1545
# Lock and Unlock. We lock the entire chain (all versions) of the
# image. 
1546
#
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
sub Lock($)
{
    my ($self) = @_;

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

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

    my $query_result =
1559
	DBQueryWarn("update images set locked=now(),locker_pid=$PID " .
1560
1561
1562
1563
1564
1565
1566
1567
1568
		    "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();
1569
    $self->{'IMAGE'}->{'locker_pid'} = $PID;
1570
1571
1572
1573
    return 0;
}

sub Unlock($)
1574
1575
{
    my ($self) = @_;
1576
1577
1578
1579
1580

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