emulabfeature.in 5.8 KB
Newer Older
1 2
#!/usr/bin/perl -w
#
3
# Copyright (c) 2003-2016 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 29 30 31 32
#
use strict;
use English;
use Getopt::Std;

#
# Create/Delete and globally enable/disable emulab features.
#
sub usage()
{
33
    print STDERR "Usage: emulabfeature <action> <feature> <other args>\n";
34 35 36 37 38 39 40
    print STDERR "  -h       This message\n";
    print STDERR "  create   Create a feature. Provide pithy description.\n";
    print STDERR "  delete   Delete existing feature.\n";
    print STDERR "  enable   Globally enable feature. Provide onoff flag.\n";
    print STDERR "  disable  Globally disable feature. Provide onoff flag.\n";
    print STDERR "  show     Show details of feature.\n";
    print STDERR "  list     List of all features.\n";
41
    print STDERR "  check    Check a feature for a user/group (-u/-g).\n";
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
    exit(-1);
}
my $optlist  = "h";
my $debug    = 0;

# Protos
sub fatal($);

#
# Please do not run as root. Hard to track what has happened.
#
if ($UID == 0) {
    die("*** $0:\n".
	"    Please do not run this as root!\n");
}

#
# Configure variables
#
my $TB		 = "@prefix@";

#
# Testbed Support libraries
#
use lib "@prefix@/lib";
use emdb;
use EmulabFeatures;
use libtestbed;
use User;
71 72
use Group;
$EmulabFeatures::verbose = 0;
73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95

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

#
# Untaint the path
# 
$ENV{'PATH'} = "/bin:/sbin:/usr/bin:";

#
# 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{h})) {
    usage();
}
usage()
96
    if (@ARGV < 1);
97

98
my $action = shift(@ARGV);
99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134

sub ShowFeature($)
{
    my ($feature) = @_;

    my $featurename = $feature->feature();
    my $enabled     = $feature->enabled();
    my $disabled    = $feature->disabled();
    my $description = $feature->description();
    my $created     = $feature->added();
    my @flags       = ();

    push(@flags, "Globally enabled")
	if ($enabled);
    push(@flags, "Globally disabled")
	if ($disabled);
    my $flags = join(",", @flags);

    print "$featurename: $flags\n";
    print "  Created: $created\n";
    print "  $description\n";
}

if ($action eq "list") {
    my @list = EmulabFeatures->List();
    
    foreach my $feature (@list) {
	ShowFeature($feature);
    }
    exit(0);
}

#
# Everything else needs a featurename.
#
usage()
135
    if (@ARGV < 1);
136

137
my $featurename = shift(@ARGV);
138 139 140 141
my $feature = EmulabFeatures->Lookup($featurename);

if ($action eq "create") {
    usage()
142
	if (@ARGV != 1);
143 144 145
    
    fatal("Feature $featurename already exists!")
	if (defined($feature));
146
    my $description = shift(@ARGV);
147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168

    $feature = EmulabFeatures->Create($featurename, $description);
    fatal("Could not create new feature $featurename!")
	if (!defined($feature));
    print "Feature $featurename has been created.\n";
}
elsif ($action eq "delete") {
    fatal("Feature $featurename does not exist!")
	if (!defined($feature));

    $feature->Delete() == 0
	or fatal("Could not delete feature $featurename!");
}    
elsif ($action eq "enable" || $action eq "disable") {
    fatal("Feature $featurename does not exist!")
	if (!defined($feature));
    
    my $result;
    #
    # By default, we are setting the global enable/disable flag.
    # Override on command line.
    #
169
    my $onoff = (@ARGV ? ($ARGV[0] ? 1 : 0) : 1);
170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214
    
    if ($action eq "enable") {
	$result = $feature->SetGlobalEnable($onoff);
    }
    elsif ($action eq "disable") {
	$result = $feature->SetGlobalDisable($onoff);
    }
    fatal("Could not $action feature $featurename!")
	if ($result != 0);
}
elsif ($action eq "show") {
    fatal("Feature $featurename does not exist!")
	if (!defined($feature));

    my @users  = ();
    my @groups = ();
    my @experiments = ();
    $feature->ListEnabled(\@users, \@groups, \@experiments);
    
    ShowFeature($feature);
    if (@users) {
	print "Users: ";
	foreach my $user (@users) {
	    print $user->uid;
	    print " ";
	}
	print "\n";
    }
    if (@groups) {
	print "Groups: ";
	foreach my $group (@groups) {
	    print $group->pid() . "/" . $group->gid();
	    print " ";
	}
	print "\n";
    }
    if (@experiments) {
	print "Experiments: ";
	foreach my $experiment (@experiments) {
	    print $experiment->pid() . "/" . $experiment->eid();
	    print " ";
	}
	print "\n";
    }
}
215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248
elsif ($action eq "check") {
    fatal("Feature $featurename does not exist!")
	if (!defined($feature));
    usage()
	if (!@ARGV);

    my $user;
    my $group;

    while (@ARGV) {
	my $opt = shift(@ARGV);
	usage()
	    if (!@ARGV);
	my $val = shift(@ARGV);

	if ($opt eq "-u") {
	    $user = User->Lookup($val);
	    fatal("No such user")
		if (!defined($user));
	}
	elsif ($opt eq "-g") {
	    $group = Group->Lookup($val);
	    fatal("No such group")
		if (!defined($group));
	}
	else {
	    usage();
	}
    }
    my $enabled = EmulabFeatures->FeatureEnabled($featurename,
						 $user, $group, undef);
    print "Feature is " . ($enabled ? "enabled" : "disabled") . "\n";
    exit($enabled);
}
249 250 251 252 253 254 255 256 257 258 259 260 261
else {
    fatal("Unknown action $action!");
}
exit(0);

sub fatal($)
{
    my ($mesg) = $_[0];

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