/*
* The MIT License
*
* Copyright (c) 2004-2010, Sun Microsystems, Inc.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package hudson.cli;
import hudson.AbortException;
import hudson.Extension;
import jenkins.model.Jenkins;
import java.util.Map;
import java.util.TreeMap;
import org.acegisecurity.AccessDeniedException;
import org.kohsuke.args4j.Argument;
/**
* Show the list of all commands.
*
* @author Kohsuke Kawaguchi
*/
@Extension
public class HelpCommand extends CLICommand {
@Argument(metaVar="COMMAND", usage="Name of the command")
public String command;
@Override
public String getShortDescription() {
return Messages.HelpCommand_ShortDescription();
}
@Override
protected int run() throws Exception {
if (!Jenkins.getActiveInstance().hasPermission(Jenkins.READ)) {
throw new AccessDeniedException("You must authenticate to access this Jenkins.\n"
+ "Use --username/--password/--password-file parameters or login command.");
}
if (command != null)
return showCommandDetails();
showAllCommands();
return 0;
}
private int showAllCommands() {
Map<String,CLICommand> commands = new TreeMap<String,CLICommand>();
for (CLICommand c : CLICommand.all())
commands.put(c.getName(),c);
for (CLICommand c : commands.values()) {
stderr.println(" "+c.getName());
stderr.println(" "+c.getShortDescription());
}
return 0;
}
private int showCommandDetails() throws Exception {
CLICommand command = CLICommand.clone(this.command);
if (command == null) {
showAllCommands();
throw new AbortException(String.format("No such command %s. Available commands are above. ", this.command));
}
command.printUsage(stderr, command.getCmdLineParser());
return 0;
}
}