/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2010 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.enterprise.admin.cli;
import java.io.*;
import java.util.*;
import java.text.*;
import org.jvnet.hk2.component.*;
import org.glassfish.api.admin.*;
import com.sun.enterprise.admin.cli.remote.RemoteCommand;
import com.sun.enterprise.universal.i18n.LocalStringsImpl;
/**
* CLI Utility class
*/
public class CLIUtil {
private static final int MAX_COMMANDS_TO_DISPLAY = 75;
private static final LocalStringsImpl strings =
new LocalStringsImpl(CLIUtil.class);
/**
* Read passwords from the password file and save them in a java.util.Map.
* @param passwordFileName password file name
* @param withPrefix decides whether prefix should be taken into account
* @return Map of the password name and value
*/
public static Map<String, String> readPasswordFileOptions(
final String passwordFileName, boolean withPrefix)
throws CommandException {
Map<String, String> passwordOptions = new HashMap<String, String>();
boolean readStdin = passwordFileName.equals("-");
InputStream is = null;
try {
is = new BufferedInputStream(
readStdin ? System.in : new FileInputStream(passwordFileName));
final Properties prop = new Properties();
prop.load(is);
for (Object key : prop.keySet()) {
final String entry = (String)key;
if (entry.startsWith(Environment.AS_ADMIN_ENV_PREFIX)) {
final String optionName = withPrefix ? entry :
entry.substring(Environment.AS_ADMIN_ENV_PREFIX.length()).
toLowerCase(Locale.ENGLISH);
final String optionValue = prop.getProperty(entry);
passwordOptions.put(optionName, optionValue);
}
}
} catch (final Exception e) {
throw new CommandException(e);
} finally {
try {
if (!readStdin && is != null)
is.close();
} catch (final Exception ignore) { }
}
return passwordOptions;
}
/**
* Display the commands from the list that are the closest match
* to the specified command.
*/
public static void displayClosestMatch(final String commandName,
String[] commands, final String msg)
throws InvalidCommandException {
try {
// remove leading "*" and ending "*" chars
int beginIndex = 0;
int endIndex = commandName.length();
if (commandName.startsWith("*"))
beginIndex = 1;
if (commandName.endsWith("*"))
endIndex = commandName.length() - 1;
final String trimmedCommandName =
commandName.substring(beginIndex, endIndex);
// if pattern doesn't start with "_", remove hidden commands
if (!trimmedCommandName.startsWith("_")) {
List<String> ncl = new ArrayList<String>();
for (String cmd : Arrays.asList(commands))
if (!cmd.startsWith("_"))
ncl.add(cmd);
commands = ncl.toArray(new String[ncl.size()]);
}
// sort commands in alphabetical order
Arrays.sort(commands);
// add all matches to the search String since we want
// to search all the commands that match the string
final String[] matchedCommands =
getMatchedCommands(trimmedCommandName, commands);
//".*"+trimmedCommandName+".*", commands);
// don't want to display more than 50 commands
if (matchedCommands.length > 0 &&
matchedCommands.length < MAX_COMMANDS_TO_DISPLAY) {
System.out.println(msg != null ? msg :
strings.get("ClosestMatchedCommands"));
for (String eachCommand : matchedCommands)
System.out.println(" " + eachCommand);
} else {
// find the closest distance
final String nearestString = StringEditDistance.findNearest(
trimmedCommandName, commands);
// don't display the string if the edit distance is too large
if (StringEditDistance.editDistance(
trimmedCommandName, nearestString) < 5) {
System.out.println(msg != null? msg :
strings.get("ClosestMatchedCommands"));
System.out.println(" " + nearestString);
} else
throw new InvalidCommandException(commandName);
}
} catch (Exception e) {
throw new InvalidCommandException(commandName);
}
}
/**
* Return all the commands that include pattern (just a literal
* string, not really a pattern) as a substring.
*/
private static String[] getMatchedCommands(final String pattern,
final String[] commands) {
List<String> matchedCommands = new ArrayList<String>();
for (int i = 0; i < commands.length; i++) {
if (commands[i].indexOf(pattern) >= 0)
matchedCommands.add(commands[i]);
}
return matchedCommands.toArray(new String[matchedCommands.size()]);
}
/**
* Return all commands, local and remote.
*
* @return the commands as a String array, sorted
*/
public static String[] getAllCommands(Habitat habitat, ProgramOptions po,
Environment env) {
try {
String[] remoteCommands = getRemoteCommands(habitat, po, env);
String[] localCommands = getLocalCommands(habitat);
String[] allCommands =
new String[localCommands.length + remoteCommands.length];
System.arraycopy(localCommands, 0,
allCommands, 0, localCommands.length);
System.arraycopy(remoteCommands, 0,
allCommands, localCommands.length, remoteCommands.length);
Arrays.sort(allCommands);
return allCommands;
} catch (CommandValidationException cve) {
return null;
} catch (CommandException ce) {
return null;
}
}
/**
* Get all the known local commands.
*
* @return the commands as a String array, sorted
*/
public static String[] getLocalCommands(Habitat habitat) {
List<String> names = new ArrayList<String>();
String cname = CLICommand.class.getName();
for (Inhabitant<?> command : habitat.getInhabitantsByContract(cname)) {
for (String name : Inhabitants.getNamesFor(command, cname))
names.add(name);
}
String[] localCommands = names.toArray(new String[names.size()]);
Arrays.sort(localCommands);
return localCommands;
}
/**
* Get the list of commands from the remote server.
*
* @return the commands as a String array, sorted
*/
public static String[] getRemoteCommands(Habitat habitat,
ProgramOptions po, Environment env)
throws CommandException, CommandValidationException {
/*
* In order to eliminate all local command names from the list
* of remote commands, we collect the local command names into
* a HashSet that we check later when collecting remote command
* names.
*/
Set<String> localnames = new HashSet<String>();
String cname = CLICommand.class.getName();
for (Inhabitant<?> command : habitat.getInhabitantsByContract(cname)) {
for (String name : Inhabitants.getNamesFor(command, cname))
localnames.add(name);
}
/*
* Now get the list of remote commands.
*/
RemoteCommand cmd =
new RemoteCommand("list-commands", po, env);
String cmds = cmd.executeAndReturnOutput("list-commands");
List<String> rcmds = new ArrayList<String>();
BufferedReader r = new BufferedReader(new StringReader(cmds));
String line;
/*
* The output of the remote list-commands command is a bunch of
* lines of the form:
* Command : cmd-name
* We extract the command name from each such line.
* XXX - depending on this output format is gross;
* should be able to send --terse to remote command
* to cause it to produce exactly the output we want.
*/
try {
while ((line = r.readLine()) != null) {
if (line.startsWith("Command")) {
int i = line.indexOf(':');
if (i < 0)
continue;
String s = line.substring(i + 1).trim();
// add it if it's not a local command
if (!localnames.contains(s))
rcmds.add(s);
}
}
} catch (IOException ioex) {
// ignore it, will never happen
}
Collections.sort(rcmds);
String[] remoteCommands = rcmds.toArray(new String[rcmds.size()]);
Arrays.sort(remoteCommands);
return remoteCommands;
}
/**
* Log the command, for debugging.
*/
public static void writeCommandToDebugLog(String[] args, int exit) {
File log = getDebugLogfile();
if (log == null)
return;
BufferedWriter out = null;
try {
out = new BufferedWriter(new FileWriter(log, true));
DateFormat dateFormat = new SimpleDateFormat("MM/dd/yyyy HH:mm:ss");
Date date = new Date();
out.write(dateFormat.format(date));
out.write(" EXIT: " + exit);
out.write(" asadmin ");
if (args != null) {
for (int i = 0; args != null && i < args.length; ++i) {
out.write(args[i] + " ");
}
}
} catch (IOException e) {
// It is just a debug file.
} finally {
if (out != null) {
try {
out.write("\n");
out.close();
} catch (Exception e) {
// ignore
}
}
}
}
private static File getDebugLogfile() {
// System Prop trumps environmental variable
String fname =
System.getProperty(CLIConstants.CLI_RECORD_ALL_COMMANDS_PROP);
if (fname == null)
fname = System.getenv(CLIConstants.CLI_RECORD_ALL_COMMANDS_PROP);
if (fname == null)
return null;
File f = new File(fname);
if (!f.exists()) {
try {
f.createNewFile();
} catch (IOException e) { /* ignore */ }
}
if (f.isFile() && f.canWrite())
return f;
else
return null;
}
}