imageid_defs.php 17.7 KB
Newer Older
1
2
3
<?php
#
# EMULAB-COPYRIGHT
4
# Copyright (c) 2006-2011 University of Utah and the Flux Group.
5
6
7
8
9
10
11
12
# All rights reserved.
#
include_once("osinfo_defs.php");	# For SpitOSIDLink() below.

class Image
{
    var	$image;
    var $types;
13
14
    var $group;
    var $project;
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37

    #
    # Constructor by lookup on unique ID
    #
    function Image($id) {
	$safe_id = addslashes($id);

	$query_result =
	    DBQueryWarn("select * from images ".
			"where imageid='$safe_id'");

	if (!$query_result || !mysql_num_rows($query_result)) {
	    $this->image = NULL;
	    return;
	}
	$this->image = mysql_fetch_array($query_result);

	#
	# Load the type info.
	#
	$types = array();
	
	$query_result = 
38
	    DBQueryFatal("select distinct type from osidtoimageid ".
39
40
41
42
43
44
			 "where imageid='$safe_id'");
	
	while ($row = mysql_fetch_array($query_result)) {
	    $types[] = $row['type'];
	}
	$this->types = $types;
45
46
47
48

	# Load lazily;
	$this->group      = null;
	$this->project    = null;
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
    }

    # Hmm, how does one cause an error in a php constructor?
    function IsValid() {
	return !is_null($this->image);
    }

    # Lookup by imageid
    function Lookup($id) {
	$foo = new Image($id);

	if (! $foo->IsValid())
	    return null;

	return $foo;
    }

    # Lookup by imagename in a project
    function LookupByName($project, $name) {
	$pid       = $project->pid();
	$safe_name = addslashes($name);
	
	$query_result =
	    DBQueryFatal("select imageid from images ".
			 "where pid='$pid' and imagename='$safe_name'");

	if (mysql_num_rows($query_result) == 0) {
	    return null;
	}
	$row = mysql_fetch_array($query_result);
	return Image::Lookup($row["imageid"]);
    }

    #
    # Refresh an instance by reloading from the DB.
    #
    function Refresh() {
	if (! $this->IsValid())
	    return -1;

	$imageid = $this->imageid();

	$query_result =
	    DBQueryWarn("select * from images where imageid='$imageid'");
    
	if (!$query_result || !mysql_num_rows($query_result)) {
	    $this->imageid = NULL;
	    return -1;
	}
	$this->imageid = mysql_fetch_array($query_result);

	#
	# Reload the type info.
	#
	$types = array();
	
	$query_result = 
106
	    DBQueryFatal("select distinct type from osidtoimageid ".
107
108
109
110
111
112
113
114
115
116
			 "where imageid='$imageid'");
	
	while ($row = mysql_fetch_array($query_result)) {
	    $types[] = $row['type'];
	}
	$this->types = $types;
	
	return 0;
    }

117
    #
118
119
    # Class function to create a new image descriptor.
    #
120
    function NewImageId($ez, $imagename, $args, &$errors) {
121
122
123
124
125
	global $suexec_output, $suexec_output_array;

        #
        # Generate a temporary file and write in the XML goo.
        #
Russ Fish's avatar
Russ Fish committed
126
	$xmlname = tempnam("/tmp", $ez ? "newimageid_ez" : "newimageid");
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
	if (! $xmlname) {
	    TBERROR("Could not create temporary filename", 0);
	    $errors[] = "Transient error(1); please try again later.";
	    return null;
	}
	if (! ($fp = fopen($xmlname, "w"))) {
	    TBERROR("Could not open temp file $xmlname", 0);
	    $errors[] = "Transient error(2); please try again later.";
	    return null;
	}

	# Add these. Maybe caller should do this?
	$args["imagename"] = $imagename;

	fwrite($fp, "<image>\n");
	foreach ($args as $name => $value) {
	    fwrite($fp, "<attribute name=\"$name\">");
	    fwrite($fp, "  <value>" . htmlspecialchars($value) . "</value>");
	    fwrite($fp, "</attribute>\n");
	}
	fwrite($fp, "</image>\n");
	fclose($fp);
	chmod($xmlname, 0666);

151
152
	$script = "webnewimageid" . ($ez ? "_ez" : "");
	$retval = SUEXEC("nobody", "nobody", "$script $xmlname",
153
154
155
156
			 SUEXEC_ACTION_IGNORE);

	if ($retval) {
	    if ($retval < 0) {
157
		$errors[] = "Transient error(3, $retval); please try again later.";
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
		SUEXECERROR(SUEXEC_ACTION_CONTINUE);
	    }
	    else {
		# unlink($xmlname);
		if (count($suexec_output_array)) {
		    for ($i = 0; $i < count($suexec_output_array); $i++) {
			$line = $suexec_output_array[$i];
			if (preg_match("/^([-\w]+):\s*(.*)$/",
				       $line, $matches)) {
			    $errors[$matches[1]] = $matches[2];
			}
			else
			    $errors[] = $line;
		    }
		}
		else
174
		    $errors[] = "Transient error(4, $retval); please try again later.";
175
176
177
178
179
180
181
182
183
184
185
186
	    }
	    return null;
	}

        #
        # Parse the last line of output. Ick.
        #
	unset($matches);
	
	if (!preg_match("/^IMAGE\s+([^\/]+)\/(\d+)\s+/",
			$suexec_output_array[count($suexec_output_array)-1],
			$matches)) {
187
	    $errors[] = "Transient error(5); please try again later.";
188
189
190
191
192
193
	    SUEXECERROR(SUEXEC_ACTION_CONTINUE);
	    return null;
	}
	$image = $matches[2];
	$newimage = image::Lookup($image);
	if (! $newimage) {
194
	    $errors[] = "Transient error(6); please try again later.";
195
196
197
198
199
200
201
202
203
204
205
206
	    TBERROR("Could not lookup new image $image", 0);
	    return null;
	}

	# Unlink this here, so that the file is left behind in case of error.
	# We can then create the image by hand from the xmlfile, if desired.
	unlink($xmlname);
	return $newimage; 
    }

    #
    # Class function to edit an image descriptor.
207
208
209
210
211
212
213
214
215
216
    #
    function EditImageid($image, $args, &$errors) {
	global $suexec_output, $suexec_output_array;

        #
        # Generate a temporary file and write in the XML goo.
        #
	$xmlname = tempnam("/tmp", "editimageid");
	if (! $xmlname) {
	    TBERROR("Could not create temporary filename", 0);
217
	    $errors[] = "Transient error(1); please try again later.";
218
219
220
221
	    return null;
	}
	if (! ($fp = fopen($xmlname, "w"))) {
	    TBERROR("Could not open temp file $xmlname", 0);
222
	    $errors[] = "Transient error(2); please try again later.";
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
	    return null;
	}

	# Add these. Maybe caller should do this?
	$args["imageid"] = $image->imageid();

	fwrite($fp, "<image>\n");
	foreach ($args as $name => $value) {
	    fwrite($fp, "<attribute name=\"$name\">");
	    fwrite($fp, "  <value>" . htmlspecialchars($value) . "</value>");
	    fwrite($fp, "</attribute>\n");
	}
	fwrite($fp, "</image>\n");
	fclose($fp);
	chmod($xmlname, 0666);

	$retval = SUEXEC("nobody", "nobody", "webeditimageid $xmlname",
			 SUEXEC_ACTION_IGNORE);

	if ($retval) {
	    if ($retval < 0) {
244
		$errors[] = "Transient error(3, $retval); please try again later.";
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
		SUEXECERROR(SUEXEC_ACTION_CONTINUE);
	    }
	    else {
		# unlink($xmlname);
		if (count($suexec_output_array)) {
		    for ($i = 0; $i < count($suexec_output_array); $i++) {
			$line = $suexec_output_array[$i];
			if (preg_match("/^([-\w]+):\s*(.*)$/",
				       $line, $matches)) {
			    $errors[$matches[1]] = $matches[2];
			}
			else
			    $errors[] = $line;
		    }
		}
		else
261
		    $errors[] = "Transient error(4, $retval); please try again later.";
262
263
264
265
266
267
268
269
270
271
272
273
	    }
	    return null;
	}

	# There are no return value(s) to parse at the end of the output.

	# Unlink this here, so that the file is left behind in case of error.
	# We can then create the image by hand from the xmlfile, if desired.
	unlink($xmlname);
	return true;
    }

274
275
276
277
278
279
280
281
282
283
284
285
286
287
    #
    # Equality test.
    #
    function SameImage($image) {
	return $image->imageid() == $this->imageid();
    }

    # accessors
    function field($name) {
	return (is_null($this->image) ? -1 : $this->image[$name]);
    }
    function imagename()	{ return $this->field("imagename"); }
    function pid()		{ return $this->field("pid"); }
    function gid()		{ return $this->field("gid"); }
288
289
    function pid_idx()		{ return $this->field("pid_idx"); }
    function gid_idx()		{ return $this->field("gid_idx"); }
290
    function imageid()		{ return $this->field("imageid"); }
291
    function uuid()		{ return $this->field("uuid"); }
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
    function creator()		{ return $this->field("creator"); }
    function creator_idx()	{ return $this->field("creator_idx"); }
    function created()		{ return $this->field("created"); }
    function description()	{ return $this->field("description"); }
    function loadpart()		{ return $this->field("loadpart"); }
    function loadlength()	{ return $this->field("loadlength"); }
    function part1_osid()	{ return $this->field("part1_osid"); }
    function part2_osid()	{ return $this->field("part2_osid"); }
    function part3_osid()	{ return $this->field("part3_osid"); }
    function part4_osid()	{ return $this->field("part4_osid"); }
    function default_osid()	{ return $this->field("default_osid"); }
    function path()		{ return $this->field("path"); }
    function magic()		{ return $this->field("magic"); }
    function ezid()		{ return $this->field("ezid"); }
    function shared()		{ return $this->field("shared"); }
    function isglobal()		{ return $this->field("global"); }
    function updated()		{ return $this->field("updated"); }

    # Return the DB data.
    function DBData()		{ return $this->image; }
    # and the types array
    function Types()		{ reset($this->types); return $this->types; }

    #
    # Access Check, determines if $user can access $this record.
    # 
    function AccessCheck($user, $access_type) {
	global $TB_IMAGEID_READINFO;
	global $TB_IMAGEID_MODIFYINFO;
	global $TB_IMAGEID_DESTROY;
	global $TB_IMAGEID_ACCESS;
	global $TB_IMAGEID_MIN;
	global $TB_IMAGEID_MAX;
	global $TBDB_TRUST_USER;
	global $TBDB_TRUST_GROUPROOT;
	global $TBDB_TRUST_LOCALROOT;
	$mintrust = $TB_IMAGEID_READINFO;

	if ($access_type < $TB_IMAGEID_MIN || $access_type > $TB_IMAGEID_MAX) {
	    TBERROR("Invalid access type $access_type!", 1);
	}

        #
        # Admins do whatever they want!
        # 
	if (ISADMIN()) {
	    return 1;
	}

	$shared = $this->shared();
	$global = $this->isglobal();
343
	$imageid= $this->imageid();
344
345
346
	$pid    = $this->pid();
	$gid    = $this->gid();
	$uid    = $user->uid();
347
348
349
	$uid_idx= $user->uid_idx();
	$pid_idx= $user->uid_idx();
	$gid_idx= $user->uid_idx();
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375

        #
        # Global ImageIDs can be read by anyone but written by Admins only.
        # 
	if ($global) {
	    if ($access_type == $TB_IMAGEID_READINFO) {
		return 1;
	    }
	    return 0;
	}

        #
        # Otherwise must have proper trust in the project.
        # 
	if ($access_type == $TB_IMAGEID_READINFO) {
	    $mintrust = $TBDB_TRUST_USER;
            #
            # Shared imageids are readable by anyone in the project.
            #
	    if ($shared)
		$gid = $pid;
	}
	else {
	    $mintrust = $TBDB_TRUST_LOCALROOT;
	}

376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
	if (TBMinTrust(TBGrpTrust($uid, $pid, $gid), $mintrust) ||
	    TBMinTrust(TBGrpTrust($uid, $pid, $pid), $TBDB_TRUST_GROUPROOT)) {
	    return 1;
	}
        # No point in looking further; never allowed.
	if ($access_type == $TB_IMAGEID_EXPORT) {
	    return 0;
	}
	
	#
	# Look in the image permissions. First look for a user permission,
	# then look for a group permission.
	#
	$query_result = 
	    DBQueryFatal("select allow_write from image_permissions ".
			 "where imageid='$imageid' and ".
			 "      permission_type='user' and ".
			 "      permission_idx='$uid_idx'");
	
	if (mysql_num_rows($query_result)) {
	    $row  = mysql_fetch_array($query_result);

            # Only allowed to read.
	    if ($access_type == $TB_IMAGEID_READINFO ||
		$access_type == $TB_IMAGEID_ACCESS)
		return 1;
	}
	$trust_none = TBDB_TRUSTSTRING_NONE;
	$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 (mysql_num_rows($query_result)) {
            # Only allowed to read.
	    if ($access_type == $TB_IMAGEID_READINFO ||
		$access_type == $TB_IMAGEID_ACCESS)
		return 1;
	}
	return 0;
420
421
    }

422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
    #
    # Load the project object for an experiment.
    #
    function Project() {
	$pid_idx = $this->pid_idx();

	if ($this->project)
	    return $this->project;

	$this->project = Project::Lookup($pid_idx);
	if (! $this->project) {
	    TBERROR("Could not lookup project $pid_idx!", 1);
	}
	return $this->project;
    }
    #
    # Load the group object for an experiment.
    #
    function Group() {
	$gid_idx = $this->gid_idx();

	if ($this->group)
	    return $this->group;

	$this->group = Group::Lookup($gid_idx);
	if (! $this->group) {
	    TBERROR("Could not lookup group $gid_idx!", 1);
	}
	return $this->group;
    }

453
    function Show($showperms = 0) {
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
	$imageid	= $this->imageid();
	$imagename	= $this->imagename();
	$pid		= $this->pid();
	$gid		= $this->gid();
	$description	= $this->description();
	$loadpart	= $this->loadpart();
	$loadlength	= $this->loadlength();
	$part1_osid	= $this->part1_osid();
	$part2_osid	= $this->part2_osid();
	$part3_osid	= $this->part3_osid();
	$part4_osid	= $this->part4_osid();
	$default_osid	= $this->default_osid();
	$path		= $this->path();
	$shared		= $this->shared();
	$globalid	= $this->isglobal();
	$creator	= $this->creator();
	$created	= $this->created();
471
	$uuid           = $this->uuid();
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
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

	if (!$description)
	    $description = "&nbsp;";
	if (!$path)
	    $path = "&nbsp;";
	if (!$created)
	    $created = "N/A";
    
        #
        # Generate the table.
        #
	echo "<table align=center border=2 cellpadding=2 cellspacing=2>\n";

	echo "<tr>
                <td>Image Name: </td>
                <td class=\"left\">$imagename</td>
              </tr>\n";

	echo "<tr>
                <td>Project: </td>
                <td class=\"left\">
                  <a href='showproject.php3?pid=$pid'>$pid</a></td>
              </tr>\n";

	echo "<tr>
                  <td>Group: </td>
                  <td class=\"left\">
                    <a href='showgroup.php3?pid=$pid&gid=$gid'>$gid</a></td>
              </tr>\n";
    
	echo "<tr>
                <td>Creator: </td>
                <td class=left>$creator</td>
     	      </tr>\n";

	echo "<tr>
                <td>Created: </td>
                <td class=left>$created</td>
 	      </tr>\n";

	echo "<tr>
                <td>Description: </td>
                <td class=left>\n";
	echo "$description";
	echo "   </td>
 	      </tr>\n";

	echo "<tr>
                <td>Load Partition: </td>
                <td class=\"left\">$loadpart</td>
              </tr>\n";

	echo "<tr>
                <td>Load Length: </td>
                <td class=\"left\">$loadlength</td>
              </tr>\n";

	if ($part1_osid) {
	    echo "<tr>
                     <td>Partition 1 OS: </td>
                     <td class=\"left\">";
	    SpitOSIDLink($part1_osid);
	    echo "   </td>
                  </tr>\n";
	}

	if ($part2_osid) {
	    echo "<tr>
                     <td>Partition 2 OS: </td>
                     <td class=\"left\">";
	    SpitOSIDLink($part2_osid);
	    echo "   </td>
                  </tr>\n";
	}

	if ($part3_osid) {
	    echo "<tr>
                     <td>Partition 3 OS: </td>
                     <td class=\"left\">";
	    SpitOSIDLink($part3_osid);
	    echo "   </td>
                  </tr>\n";
	}

	if ($part4_osid) {
	    echo "<tr>
                     <td>Partition 4 OS: </td>
                     <td class=\"left\">";
	    SpitOSIDLink($part4_osid);
	    echo "   </td>
                  </tr>\n";
	}

	if ($default_osid) {
	    echo "<tr>
                     <td>Boot OS: </td>
                     <td class=\"left\">";
	    SpitOSIDLink($default_osid);
	    echo "   </td>
                  </tr>\n";
	}

	echo "<tr>
                <td>Filename: </td>
                <td class=left>\n";
	echo "$path";
	echo "  </td>
              </tr>\n";

	echo "<tr>
                  <td>Types: </td>
                  <td class=left>\n";
	echo "&nbsp;";
	foreach ($this->Types() as $type) {
	    echo "$type &nbsp; ";
	}
	echo "  </td>
              </tr>\n";

	echo "<tr>
                <td>Shared?: </td>
                <td class=left>\n";
	if ($shared)
	    echo "Yes";
	else
	    echo "No";
    
	echo "  </td>
              </tr>\n";

	echo "<tr>
                <td>Global?: </td>
                <td class=left>\n";

	if ($globalid)
	    echo "Yes";
	else
	    echo "No";
    
	echo "  </td>
              </tr>\n";

	echo "<tr>
                <td>Internal ID: </td>
                <td class=left>$imageid</td>
              </tr>\n";

619
620
621
622
623
	echo "<tr>
                <td>UUID: </td>
                <td class=left>$uuid</td>
              </tr>\n";

624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
	#
	# Show who all can access this image outside the project.
	#
	if ($showperms) {
	    $query_result =
		DBQueryFatal("select * from image_permissions ".
			     "where imageid='$imageid' ".
			     "order by permission_type,permission_id");
	    if (mysql_num_rows($query_result)) {
		echo "<tr>
                      <td align=center colspan=2>
                      External permissions
                      </td>
                  </tr>\n";

		while ($row = mysql_fetch_array($query_result)) {
		    $perm_type = $row['permission_type'];
		    $perm_idx  = $row['permission_idx'];
		    $writable  = $row['allow_write'];

		    if ($writable) {
			$writable = "(read/write)";
		    }
		    else {
			$writable = "(read only)";
		    }

		    if ($perm_type == "user") {
			$user = User::Lookup($perm_idx);
			if (isset($user)) {
			    $uid = $user->uid();
			    echo "<tr>
                                    <td>User: </td>
                                    <td class=left>$uid $writable</td>
                                  </tr>\n";
			}
		    }
		    elseif ($perm_type == "group") {
			$group = Group::Lookup($perm_idx);
			if (isset($group)) {
			    $pid = $group->pid();
			    $gid = $group->gid();
			    echo "<tr>
                                    <td>Group: </td>
                                    <td class=left>$pid/$gid $writable</td>
                                  </tr>\n";
			}
		    }
		}
	    }
	}

676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
	echo "</table>\n";
    }

    #
    # See if an image is inuse.
    #
    function InUse() {
	$imageid = $this->imageid();

	$query_result1 =
	    DBQueryFatal("select * from current_reloads ".
			 "where image_id='$imageid'");
	$query_result2 =
	    DBQueryFatal("select * from scheduled_reloads ".
			 "where image_id='$imageid'");
	$query_result3 =
	    DBQueryFatal("select * from node_type_attributes ".
			 "where attrkey='default_imageid' and ".
			 "      attrvalue='$imageid' limit 1");

	if (mysql_num_rows($query_result1) ||
	    mysql_num_rows($query_result2) ||
	    mysql_num_rows($query_result3)) {
	    return 1;
	}
	return 0;
    }
}