delete_image.in 8.72 KB
Newer Older
1 2
#!/usr/bin/perl -w
#
3
# Copyright (c) 2000-2017 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 23 24 25 26
# 
# {{{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/>.
# 
# }}}
#
use English;
use strict;
use Getopt::Std;
27
use File::Basename;
28 29 30 31 32 33 34
use Data::Dumper;

#
# Delete an image (descriptor) 
#
sub usage()
{
35
    print("Usage: delete_image [[-f | -F] -p | -r] <imagename>\n".
36
	  "Options:\n".
37
	  "       -p     Purge the disk image file(s)\n".
38
	  "       -r     Rename the disk image file(s) instead (default)\n".
39
	  "       -n     Impotent mode, show what would be done.\n".
40
	  "       -f     Force deletion of system image\n".
41
	  "       -F     Force deletion of global system image\n");
42 43
    exit(-1);
}
44
my $optlist     = "dFprnf";
45 46
my $debug       = 0;
my $purge       = 0;
47
my $rename      = 1;
48
my $force       = 0;
49
my $FORCE       = 0;
50 51
my $impotent    = 0;
my $needunlock  = 0;
52 53 54 55

#
# Configure variables
#
56 57 58 59 60 61
my $TB             = "@prefix@";
my $PROJROOT       = "@PROJROOT_DIR@";
my $TBOPS          = "@TBOPSEMAIL@";
my $friskiller     = "$TB/sbin/frisbeehelper";
my $WITHPROVENANCE = @IMAGEPROVENANCE@;
my $doprovenance   = 0;
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

#
# Untaint the path
#
$ENV{'PATH'} = "$TB/bin:$TB/sbin:/bin:/usr/bin:/usr/bin:/usr/sbin";
delete @ENV{'IFS', 'CDPATH', 'ENV', 'BASH_ENV'};

#
# Turn off line buffering on output
#
$| = 1;

#
# We don't want to run this script unless its the real version.
#
if ($EUID != 0) {
    die("*** $0:\n".
	"    Must be setuid! Maybe its a development version?\n");
}

#
# Load the Testbed support stuff.
#
use lib "@prefix@/lib";
use EmulabConstants;
87
use EmulabFeatures;
88
use libEmulab;
89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107
use libtestbed;
use User;
use Image;

# Protos
sub fatal($);

#
# Parse command arguments. Once we return from getopts, all that should be
# left are the required arguments.
#
my %options = ();
if (! getopts($optlist, \%options)) {
    usage();
}
if (defined($options{"d"})) {
    $debug = 1;
}
if (defined($options{"p"})) {
108 109
    $purge  = 1;
    $rename = 0;
110
}
111 112 113 114 115 116 117
if (defined($options{"r"})) {
    $rename = 1;
}
if (defined($options{"n"})) {
    $impotent = 1;
}
if (defined($options{"F"})) {
118 119 120
    $FORCE = 1;
}
if (defined($options{"f"})) {
121 122
    $force = 1;
}
123 124
usage()
    if (@ARGV != 1);
125 126
usage()
    if ($purge && $rename);
127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143

my $imageid = shift(@ARGV);

#
# Map invoking user to object. 
#
my $this_user = User->ThisUser();
if (! defined($this_user)) {
    fatal("You ($UID) do not exist!");
}
my $image = Image->Lookup($imageid);
if (!defined($image)) {
    fatal("Image does not exist in the DB!");
}
if (!$image->AccessCheck($this_user, TB_IMAGEID_DESTROY())) {
    fatal("You do not have permission to delete this image!");
}
144

145
if ($image->pid() eq TBOPSPID() && $image->global() && !$FORCE) {
146 147 148 149
    fatal("Refusing to delete global system image $image. ".
	  "Use -F if you are sure.\n");
}

150 151 152
#
# Before we do anything destructive, we lock the descriptor.
#
153 154 155 156 157
if (!$impotent) {
    if ($image->Lock()) {
	fatal("Image is locked, please try again later!\n");
    }
    $needunlock = 1;
158
}
159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176
$imageid      = $image->imageid();
my $imagename = $image->imagename();
my $imagepid  = $image->pid();

#
# Need root to delete the image file later.
#
$EUID = $UID;

#
# Be sure to kill off running frisbee. If a node is trying to load that
# image, well tough. 
#
system("$friskiller -k $imageid");
if ($?) {
    fatal("Could not kill running frisbee for $imageid!");
}

177 178 179 180
#
# When IMAGEPROVENANCE is on, we never delete system images, we
# rename them. 
#
181
if ($image->pid() eq TBOPSPID() && !$force) {
182 183 184 185 186 187 188 189
    if ($purge) {
	$purge  = 0;
	print STDERR "Ignoring purge option for system image. \n";
    }
    if ($WITHPROVENANCE) {
	print STDERR "Turning on rename option for system image. \n";
	$rename = 1;
    }
190 191
}

192 193 194 195
#
# Since admins will often delete image descriptors for users, we are
# setuid root. Flip for deleting the image file.
#
196
if ($purge || $rename) {
197 198
    my $isdirpath = $image->IsDirPath();
    
199 200 201 202 203 204 205
    #
    # When doing image provenance, we have to deal with all versions
    # of the image. 
    #
    my @images = ();
    if ($image->AllVersions(\@images)) {
	fatal("Could not get list of image (versions)");
206
    }
207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227

    #
    # If the path is a directory, we can just do a rename on it.
    #
    if ($isdirpath) {
	my $dirname = $image->path();
	
	if ($purge) {
	    if ($impotent) {
		print "Would remove directory $dirname\n" if (-e $dirname);
	    }
	    else {
		$EUID = 0;
		system("/bin/rm -rf $dirname");
		if ($?) {
		    fatal("Could not remove $dirname");
		}
		$EUID = $UID;
	    }
	}
	else {
Leigh B Stoller's avatar
Leigh B Stoller committed
228
	    my $newname = dirname($dirname) . "/" . basename($dirname) .
229
		"," . $image->imageid();
230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253

	    if ($impotent) {
		print "Would rename $dirname to $newname\n" if (-e $dirname);
	    }
	    else {
		if (-e $dirname) {
		    $EUID = 0;
		    system("/bin/mv -fv $dirname $newname");
		    if ($?) {
			fatal("Could not rename $dirname to $newname");
		    }
		    $EUID = $UID;
		}
		# Hmm, need an update all versions method.
		foreach my $imageversion (@images) {
		    $imageversion->Update({"path" => $newname});
		}
	    }
	}
	#
	# Fall into the loop below to clean up stale image versions and
	# backup files.
	#
    }
254 255 256
    foreach my $imageversion (@images) {
	my @todelete = ();
	my @torename = ();
257
	my $filename = $imageversion->FullImageFile();
258 259 260

	push(@torename, $filename);
	push(@todelete, "$filename.bak");
261 262 263 264 265 266 267 268 269 270 271
	push(@todelete, "$filename.tmp");
	push(@torename, $imageversion->FullImageSHA1File());
	push(@torename, $imageversion->FullImageSigFile());

	# Backwards compat with non-directory image paths.
	if ($filename ne $imageversion->DeltaImageFile()) {
	    $filename = $imageversion->DeltaImageFile();
	    push(@torename, $filename);
	    push(@todelete, "$filename.bak");
	    push(@todelete, "$filename.tmp");
	    push(@torename, $imageversion->DeltaImageSHA1File());
272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302
	}

	# We throw away versions that never came ready or released.
	if ($purge ||
	    !($imageversion->ready() && $imageversion->released())) {
	    @todelete = (@todelete, @torename);
	    @torename = ();
	}
	# Throw away the slot if it never came ready or released.
	if (!($imageversion->ready() && $imageversion->released())) {
	    if ($impotent) {
		my $vers = $imageversion->version();
		print "Would kill version $vers that never came ready\n";
		next;
	    }
	    $imageversion->DeleteVersion();
	}

	$EUID = 0;
	foreach my $file (@todelete) {
	    if (-e $file) {
		if ($impotent) {
		    print "Would delete $file\n";
		    next;
		}
		if (! unlink($file)) {
		    SENDMAIL($TBOPS,
			     "delete_image: Could not remove image file",
			     "Could not remove $file\n".
			     "Someone will need to do this by hand.\n");
		}
303 304
	    }
	}
305 306 307 308 309 310 311 312
	$EUID = $UID;
	
	#
	# Skip this part if we did a directory rename above.
	#
	next
	    if ($isdirpath);
	
313 314 315 316 317
	#
	# Delete with rename; move the current files out of the way
	# so that they do not conflict with a later image of the same name.
	# We do this by creating a subdir for the files.
	#
318
	$EUID = 0;
319 320
	if (@torename) {
	    my $dirname = dirname($imageversion->path()) .
321
		"/" . $image->imagename() . "," . $image->imageid();
322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347

	    if (! -e $dirname && !$impotent) {
		if (! mkdir("$dirname", 0775)) {
		    fatal("Could not mkdir $dirname");
		}
	    }
	    foreach my $file (@torename) {
		my $newname = $dirname . "/" . basename($file);
		
		if ($impotent) {
		    print "Would rename $file to $newname\n" if (-e $file);
		    next;
		}
		if (-e $file) {
		    system("/bin/mv -fv $file $newname");
		    if ($?) {
			fatal("Could not rename $file to $dirname");
		    }
		}
		if ($file eq $filename &&
		    $imageversion->Update({"path" => $newname})) {
		    fatal("Could not update path for $imageversion");
		}
	    }
	}
	$EUID = $UID;
348 349
    }
}
350 351 352
exit(0)
    if ($impotent);

353 354 355 356 357 358 359
#
# If using the image tracker, have to notify the IMS.
#
if (GetSiteVar("protogeni/use_imagetracker")) {
    $image->SchedIMSDeletion() == 0
	or fatal("Could not schedule IMS deletion");
}
360 361 362 363
if ($image->Delete() != 0) {
    fatal("Could not delete image!");
}
$this_user->SendEmail("delete_image: Image has been deleted",
364 365
		      "Image $imagepid,$imagename ($imageid) has ".
		      "been deleted by $this_user\n");
366
exit(0);
367
    
368 369 370 371
sub fatal($)
{
    my ($mesg) = @_;

372 373 374
    $image->Unlock()
	if ($needunlock);

375 376 377
    die("*** $0:\n".
	"    $mesg\n");
}