editexp.in 12.8 KB
Newer Older
1 2
#!/usr/bin/perl -wT
#
3
# Copyright (c) 2000-2011 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 27 28
#
use English;
use strict;
use Getopt::Std;
use XML::Simple;
use Data::Dumper;
29
use Cwd qw(realpath);
30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 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 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122

#
# Back-end script to change experiment info from an XML description.
#
sub usage()
{
    print("Usage: editexp [-v] <xmlfile>\n");
    exit(-1);
}
my $optlist = "dv";
my $debug   = 0;
my $verify  = 0;	# Check data and return status only. 

#
# Configure variables
#
my $TB		= "@prefix@";
my $TBOPS       = "@TBOPSEMAIL@";
my $TBAUDIT	= "@TBAUDITEMAIL@";

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

#
# Load the Testbed support stuff.
#
use lib "@prefix@/lib";
use libdb;
use libtestbed;
use User;
use Project;
use Experiment;

# Protos
sub fatal($);
sub UserError(;$);
sub escapeshellarg($);

#
# 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{"v"})) {
    $verify = 1;
}
if (@ARGV != 1) {
    usage();
}
my $xmlfile  = shift(@ARGV);

#
# Map invoking user to object. 
# If invoked as "nobody" we are coming from the web interface and the
# current user context is "implied" (see tbauth.php3).
#
my $this_user;

if (getpwuid($UID) ne "nobody") {
    $this_user = User->ThisUser();

    if (! defined($this_user)) {
	fatal("You ($UID) do not exist!");
    }
    # You don't need admin privileges to change experiment info.
}
else {
    #
    # Check the filename when invoked from the web interface; must be a
    # file in /tmp.
    #
    if ($xmlfile =~ /^([-\w\.\/]+)$/) {
	$xmlfile = $1;
    }
    else {
	fatal("Bad data in pathname: $xmlfile");
    }

    # Use realpath to resolve any symlinks.
123
    my $translated = realpath($xmlfile);
124 125 126 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 ($translated =~ /^(\/tmp\/[-\w\.\/]+)$/) {
	$xmlfile = $1;
    }
    else {
	fatal("Bad data in translated pathname: $xmlfile");
    }

    # The web interface (and in the future the xmlrpc interface) sets this.
    $this_user = User->ImpliedUser();

    if (! defined($this_user)) {
	fatal("Cannot determine implied user!");
    }
}

#
# These are the fields that we allow to come in from the XMLfile.
#
my $SLOT_OPTIONAL	= 0x1;	# The field is not required.
my $SLOT_REQUIRED	= 0x2;  # The field is required and must be non-null.
my $SLOT_ADMINONLY	= 0x4;  # Only admins can set this field.
#
# XXX We should encode all of this in the DB so that we can generate the
# forms on the fly, as well as this checking code.
#
my %xmlfields =
    # XML Field Name        DB slot name         Flags             Default
151
    ("experiment"	=> ["eid_idx",		$SLOT_REQUIRED],
152

153
     # The rest are optional, so we can skip passing ones that are not changing
154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188
     "description"	=> ["description",	$SLOT_OPTIONAL],
     "idle_ignore"	=> ["idle_ignore",	$SLOT_OPTIONAL],
     "swappable"	=> ["swappable",	$SLOT_OPTIONAL],
     "noswap_reason"	=> ["noswap_reason",	$SLOT_OPTIONAL],
     "idleswap"		=> ["idleswap",		$SLOT_OPTIONAL],
     "idleswap_timeout"	=> ["idleswap_timeout",	$SLOT_OPTIONAL],
     "noidleswap_reason"=> ["noidleswap_reason",$SLOT_OPTIONAL],
     "autoswap"		=> ["autoswap",		$SLOT_OPTIONAL],
     "autoswap_timeout"	=> ["autoswap_timeout",	$SLOT_OPTIONAL],
     "savedisk"		=> ["savedisk",		$SLOT_OPTIONAL],
     "cpu_usage"	=> ["cpu_usage",	$SLOT_OPTIONAL],
     "mem_usage"	=> ["mem_usage",	$SLOT_OPTIONAL],
     "batchmode"	=> ["batchmode",	$SLOT_OPTIONAL],
     "linktest_level"	=> ["linktest_level",	$SLOT_OPTIONAL]);

#
# Must wrap the parser in eval since it exits on error.
#
my $xmlparse = eval { XMLin($xmlfile,
			    VarAttr => 'name',
			    ContentKey => '-content',
			    SuppressEmpty => undef); };
fatal($@)
    if ($@);

#
# Process and dump the errors (formatted for the web interface).
# We should probably XML format the errors instead but not sure I want
# to go there yet.
#
my %errors = ();

#
# Make sure all the required arguments were provided.
#
189 190
my $key;
foreach $key (keys(%xmlfields)) {
191 192 193 194 195 196 197 198 199 200 201 202 203 204 205
    my (undef, $required, undef) = @{$xmlfields{$key}};

    $errors{$key} = "Required value not provided"
	if ($required & $SLOT_REQUIRED  &&
	    ! exists($xmlparse->{'attribute'}->{"$key"}));
}
UserError()
    if (keys(%errors));

#
# We build up an array of arguments to pass to Experiment->Editexp() as we check
# the attributes.
#
my %editexp_args = ();

206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230
#
# Wildcard keys have one or more *'s in them like simple glob patterns.
# This allows multiple key instances for categories of attributes, and
# putting a "type signature" in the key for arg checking, as well.
#
# Wildcards are made into regex's by anchoring the ends and changing each * to
# a "word" (group of alphahumeric.)  A tail * means "the rest", allowing
# multiple words separated by underscores or dashes.
#
my $wordpat = '[a-zA-Z0-9]+';
my $tailpat = '[-\w]+';
my %wildcards;
foreach $key (keys(%xmlfields)) {
    if (index($key, "*") >= 0) {
	my $regex = '^' . $key . '$';
	$regex =~ s/\*\$$/$tailpat/;
	$regex =~ s/\*/$wordpat/g;
	$wildcards{$key} = $regex;
    }
}
# Key ordering is lost in a hash.
# Put longer matching wildcard keys before their prefix.
my @wildkeys = reverse(sort(keys(%wildcards)));

foreach $key (keys(%{ $xmlparse->{'attribute'} })) {
231
    my $value = $xmlparse->{'attribute'}->{"$key"}->{'value'};
232 233 234
    if (!defined($value)) {	# Empty string comes from XML as an undef value.
	$xmlparse->{'attribute'}->{"$key"}->{'value'} = $value = "";
    }
235

236 237
    print STDERR "User attribute: '$key' -> '$value'\n"
	if ($debug);
238

239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257
    my $field = $key;
    my $wild;
    if (!exists($xmlfields{$key})) {

	# Not a regular key; look for a wildcard regex match.
        foreach my $wildkey (@wildkeys) {
	    my $regex = $wildcards{$wildkey};
	    if ($wild = $key =~ /$regex/) {
		$field = $wildkey;
		print STDERR "Wildcard: '$key' matches '$wildkey'\n"
		    if ($debug);
		last; # foreach $wildkey
	    }
	}
	if (!$wild) {
	    $errors{$key} = "Unknown attribute";
	    next; # foreach $key
	}
    }
258

259
    my ($dbslot, $required, $default) = @{$xmlfields{$field}};
260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289

    if ($required & $SLOT_REQUIRED) {
	# A slot that must be provided, so do not allow a null value.
	if (!defined($value)) {
	    $errors{$key} = "Must provide a non-null value";
	    next;
	}
    }
    if ($required & $SLOT_OPTIONAL) {
	# Optional slot. If value is null skip it. Might not be the correct
	# thing to do all the time?
	if (!defined($value)) {
	    next
		if (!defined($default));
	    $value = $default;
	}
    }
    if ($required & $SLOT_ADMINONLY) {
	# Admin implies optional, but thats probably not correct approach.
	$errors{$key} = "Administrators only"
	    if (! $this_user->IsAdmin());
    }
	
    # Now check that the value is legal.
    if (! TBcheck_dbslot($value, "experiments", 
			 $dbslot, TBDB_CHECKDBSLOT_ERROR)) {
	$errors{$key} = TBFieldErrorString();
	next;
    }

290
    $editexp_args{$key} = $value;
291 292 293 294 295 296 297 298 299
}
UserError()
    if (keys(%errors));

#
# Now do special checks.
#
my $doemail = 0;

300
my $experiment = Experiment->Lookup($editexp_args{"experiment"});
301 302 303 304 305 306 307 308 309 310 311 312 313 314 315
if (!defined($experiment)) {
    UserError("Experiment: No such experiment");
}
if (!$experiment->AccessCheck($this_user, TB_EXPT_MODIFY())) {
    UserError("Experiment: Not enough permission");
}

#
# Description must not be blank.
#
if ((exists($editexp_args{"description"}) ?
     $editexp_args{"description"} eq "" :
     $experiment->description() eq "")) {
    UserError("Description: Missing Field");
}
Russ Fish's avatar
Russ Fish committed
316 317 318 319
if (exists($editexp_args{"description"})) {
    $editexp_args{"description"} = 
	escapeshellarg($editexp_args{"description"});
}
320 321 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 348 349 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 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

#
# Swappable/Idle Ignore
# Any of these which are not "1" become "0".
#
# Idle Ignore
#
if (exists($editexp_args{"idle_ignore"})) {
    if ($editexp_args{"idle_ignore"} ne "1") {
	$editexp_args{"idle_ignore"} = 0;
    }
}

#
# Swappable
#
if (exists($editexp_args{"swappable"})) {
    if ($editexp_args{"swappable"} ne "1") {
	$editexp_args{"swappable"} = 0;

	# Turning off swappable, must provide justification.
	if ((exists($editexp_args{"noswap_reason"}) ?
	     $editexp_args{"noswap_reason"} eq "" :
	     $experiment->noswap_reason() eq "")) {
	    if (!$this_user->IsAdmin()) {
		UserError("Swappable: No justification provided");
	    }
	    else {
		$editexp_args{"noswap_reason"} = "ADMIN";
	    }
	}
	if ($experiment->swappable()) {
	    $doemail = 1;
	}
    }
}
if (exists($editexp_args{"noswap_reason"})) {
    $editexp_args{"noswap_reason"} = 
	escapeshellarg($editexp_args{"noswap_reason"});
}

#
# IdleSwap
#
my $idleswaptimeout = TBGetSiteVar("idle/threshold");
if (exists($editexp_args{"idleswap_timeout"})) {
    if ($editexp_args{"idleswap_timeout"} <= 0 ||
	($editexp_args{"idleswap_timeout"} > $idleswaptimeout &&
	 !$this_user->IsAdmin())) {
	UserError("Idleswap: Invalid time provided" .
		  " (0 < X <= $idleswaptimeout)");
    }
}
if (exists($editexp_args{"idleswap"})) {
    if ($editexp_args{"idleswap"} ne "1") {
	$editexp_args{"idleswap"} = 0;

	# Turning off idleswap, must provide justification.
	if ((exists($editexp_args{"noidleswap_reason"}) ?
	     $editexp_args{"noidleswap_reason"} eq "" :
	     $experiment->noidleswap_reason() eq "")) {
	    if (! $this_user->IsAdmin()) {
		UserError("IdleSwap: No justification provided");
	    }
	    else {
		$editexp_args{"noidleswap_reason"} = "ADMIN";
	    }
	}
	if ($experiment->idleswap()) {
	    $doemail = 1;
	}
	#XXX $editexp_args{"idleswap_timeout"} = 0;
    }
}
if (exists($editexp_args{"noidleswap_reason"})) {
    $editexp_args{"noidleswap_reason"} =
	escapeshellarg($editexp_args{"noidleswap_reason"});
}

#
# AutoSwap
#
402 403 404 405 406 407 408 409 410
if (exists($editexp_args{"autoswap"})) {
    if ($editexp_args{"autoswap"} ne "1") {
	if (!$this_user->IsAdmin()) {
	    UserError("Max Duration: ".
		      "you must ask testbed operations to disable this");
	}
	$editexp_args{"autoswap"} = 0;
    }
}
411
my $autoswap_max = TBGetSiteVar("general/autoswap_max");
412 413 414 415
if (exists($editexp_args{"autoswap_timeout"})) {
    if ($editexp_args{"autoswap_timeout"} <= 0) {
	UserError("Max Duration: Invalid time provided");
    }
416
    if ($editexp_args{"autoswap_timeout"} > $autoswap_max &&
417
	!$this_user->IsAdmin()) {
418
	UserError("Max Duration: $autoswap_max hours maximum - ".
419
		  "you must ask testbed operations for more");
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 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 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
    }
}

#
# Swapout disk state saving
#
if (exists($editexp_args{"savedisk"})) {
    if ($editexp_args{"savedisk"} ne "1") {
	$editexp_args{"savedisk"} = 0;
    }
}

#
# CPU Usage
#
if (exists($editexp_args{"cpu_usage"}) &&
    $editexp_args{"cpu_usage"} ne "") {

    if ($editexp_args{"cpu_usage"} < 0 ||
	$editexp_args{"cpu_usage"} > 5) {
	UserError("CPU Usage: Invalid (0 <= X <= 5)");
    }
}

#
# Mem Usage
#
if (exists($editexp_args{"mem_usage"}) &&
    $editexp_args{"mem_usage"} ne "") {

    if ($editexp_args{"mem_usage"} < 0 ||
	$editexp_args{"mem_usage"} > 5) {
	UserError("Mem Usage: Invalid (0 <= X <= 5)");
    }
}

#
# Linktest level
#
if (exists($editexp_args{"linktest_level"}) &&
    $editexp_args{"linktest_level"} ne "") {

    if ($editexp_args{"linktest_level"} < 0 ||
	$editexp_args{"linktest_level"} > 4) {
	UserError("Linktest Level: Invalid (0 <= X <= 4)");
    }
}

exit(0)
    if ($verify);

#
# Now safe to change experiment info.
#
# We pass the Experiment along as an argument to EditExp(), so remove it from
# the argument array.
#
delete($editexp_args{"experiment"});

my $usrerr;
my $editexp_val = Experiment->EditExp($experiment, $this_user, $doemail,
				      \%editexp_args, \$usrerr);
UserError($usrerr)
    if (defined($usrerr));
fatal("Could not modify Experiment!")
    if (!defined($editexp_val));

exit(0);

sub fatal($)
{
    my ($mesg) = @_;

    print STDERR "*** $0:\n".
	         "    $mesg\n";
    # Exit with negative status so web interface treats it as system error.
    exit(-1);
}

sub UserError(;$)
{
    my ($mesg) = @_;

    if (keys(%errors)) {
	foreach my $key (keys(%errors)) {
	    my $val = $errors{$key};
	    print "${key}: $val\n";
	}
    }
    print "$mesg\n"
	if (defined($mesg));

    # Exit with positive status so web interface treats it as user error.
    exit(1);
}

sub escapeshellarg($)
{
    my ($str) = @_;

    $str =~ s/[^[:alnum:]]/\\$&/g;
    return $str;
}