/*
* Written and copyright 2001-2004 Tobias Minich. Distributed under the GNU
* General Public License; see the README file. This code comes with NO
* WARRANTY.
*
*
* ConsoleInput.java
*
* Created on 6. Oktober 2003, 23:26
*/
package org.gudy.azureus2.ui.console;
import java.io.ByteArrayInputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.PrintStream;
import java.io.Reader;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.Iterator;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Properties;
import java.util.Vector;
import org.apache.log4j.Appender;
import org.apache.log4j.ConsoleAppender;
import org.apache.log4j.Logger;
import org.apache.log4j.PatternLayout;
import org.apache.log4j.varia.DenyAllFilter;
import org.gudy.azureus2.core3.config.COConfigurationManager;
import org.gudy.azureus2.core3.download.DownloadManager;
import org.gudy.azureus2.core3.download.DownloadManagerState;
import org.gudy.azureus2.core3.global.GlobalManager;
import org.gudy.azureus2.core3.logging.*;
import org.gudy.azureus2.core3.torrentdownloader.TorrentDownloader;
import org.gudy.azureus2.core3.torrentdownloader.TorrentDownloaderCallBackInterface;
import org.gudy.azureus2.core3.torrentdownloader.TorrentDownloaderFactory;
import org.gudy.azureus2.core3.torrentdownloader.impl.TorrentDownloaderManager;
import org.gudy.azureus2.core3.util.Constants;
import org.gudy.azureus2.core3.util.Debug;
import org.gudy.azureus2.core3.util.SystemProperties;
import org.gudy.azureus2.plugins.PluginException;
import org.gudy.azureus2.plugins.PluginInterface;
import org.gudy.azureus2.plugins.PluginManager;
import org.gudy.azureus2.plugins.installer.InstallablePlugin;
import org.gudy.azureus2.plugins.installer.PluginInstallerListener;
import org.gudy.azureus2.plugins.update.Update;
import org.gudy.azureus2.plugins.update.UpdateCheckInstance;
import org.gudy.azureus2.plugins.update.UpdateCheckInstanceListener;
import org.gudy.azureus2.plugins.update.UpdateManager;
import org.gudy.azureus2.ui.common.UIConst;
import org.gudy.azureus2.ui.console.commands.*;
import org.gudy.azureus2.ui.console.util.TextWrap;
import org.gudy.azureus2.update.CorePatchChecker;
import org.gudy.azureus2.update.UpdaterUpdateChecker;
import com.aelitis.azureus.core.AzureusCore;
import com.aelitis.azureus.core.AzureusCoreLifecycleAdapter;
/**
* @author Tobias Minich
*/
public class ConsoleInput extends Thread {
private static final String ALIASES_CONFIG_FILE = "console.aliases.properties";
public final AzureusCore azureus_core;
public final PrintStream out;
public final List torrents = new ArrayList();
public File[] adds = null;
private final CommandReader br;
private final boolean controlling;
private boolean running;
// previous command
private final Vector oldcommand = new Vector();
private final static List pluginCommands = new ArrayList();
public final Properties aliases = new Properties();
private final Map commands = new LinkedHashMap();
private final List helpItems = new ArrayList();
private final UserProfile userProfile;
/**
* can be used by plugins to register console commands since they may not have access to
* each ConsoleInput object that is created.
*/
public static void registerPluginCommand(Class clazz)
{
if( ! IConsoleCommand.class.isAssignableFrom(clazz))
{
throw new IllegalArgumentException("Class must implement IConsoleCommand");
}
pluginCommands.add( clazz );
}
public static void unregisterPluginCommand(Class clazz)
{
pluginCommands.remove(clazz);
}
/** Creates a new instance of ConsoleInput */
public
ConsoleInput(
String con,
AzureusCore _azureus_core,
Reader _in,
PrintStream _out,
Boolean _controlling)
{
this( con, _azureus_core, _in, _out, _controlling, UserProfile.DEFAULT_USER_PROFILE);
}
public ConsoleInput( String con, AzureusCore _azureus_core, Reader _in, PrintStream _out, Boolean _controlling, UserProfile profile)
{
super("Console Input: " + con);
this.out = _out;
this.azureus_core = _azureus_core;
this.userProfile = profile;
this.controlling = _controlling.booleanValue();
this.br = new CommandReader(_in);
System.out.println( "ConsoleInput: initializing..." );
initialise();
System.out.println( "ConsoleInput: initialized OK" );
System.out.println( "ConsoleInput: starting..." );
start();
System.out.println( "ConsoleInput: started OK" );
}
/**
* Simple constructor to allow other components to use the console commands such as "set"
* @param con
* @param _azureus_core
* @param _out
*/
public ConsoleInput(AzureusCore _azureus_core, PrintStream _out )
{
super( "" );
this.out = _out;
this.azureus_core = _azureus_core;
this.userProfile = UserProfile.DEFAULT_USER_PROFILE;
this.controlling = false;
this.br = new CommandReader( new InputStreamReader( new ByteArrayInputStream(new byte[0])));
if (Logger.getRootLogger().getAppender("ConsoleAppender")==null) {
Appender app;
app = new ConsoleAppender(new PatternLayout(PatternLayout.TTCC_CONVERSION_PATTERN));
app.setName("ConsoleAppender");
app.addFilter( new DenyAllFilter() ); //'log off' by default
Logger.getRootLogger().addAppender(app);
}
initialise();
}
protected void initialise() {
registerAlertHandler();
registerCommands();
registerPluginCommands();
if ( azureus_core != null ){
if ( controlling ){
// don't check updates if we're not controlling things
azureus_core.addLifecycleListener(
new AzureusCoreLifecycleAdapter()
{
public void
started(
AzureusCore core )
{
registerUpdateChecker();
}
});
}
try {
loadAliases();
} catch (IOException e) {
out.println("Error while loading aliases: " + e.getMessage());
}
}
// populate the old command so that '.' does something sensible first time around
oldcommand.add("sh");
oldcommand.add("t");
}
/**
* begins the download of the torrent in the specified file, downloading
* it to the specified output directory. We also annotate the download with the
* current username
* @param filename
* @param outputDir
*/
public void downloadTorrent( String filename, String outputDir )
{
DownloadManager manager = azureus_core.getGlobalManager().addDownloadManager(filename, outputDir);
manager.getDownloadState().setAttribute(DownloadManagerState.AT_USER, getUserProfile().getUsername());
}
/**
* downloads the remote torrent file. once we have downloaded the .torrent file, we
* pass the data to the downloadTorrent() method for further processing
* @param url
* @param outputDir
*/
public void downloadRemoteTorrent( String url, final String outputDir )
{
TorrentDownloader downloader = TorrentDownloaderFactory.create(new TorrentDownloaderCallBackInterface() {
public void
TorrentDownloaderEvent(
int state,
TorrentDownloader inf)
{
if( state == TorrentDownloader.STATE_FINISHED ){
out.println("Torrent file download complete. Starting torrent");
TorrentDownloaderManager.getInstance().remove(inf);
downloadTorrent( inf.getFile().getAbsolutePath(), outputDir );
}else{
if ( state == TorrentDownloader.STATE_ERROR ){
out.println( "Torrent file download failed: " + inf.getError());
}
TorrentDownloaderManager.getInstance().TorrentDownloaderEvent(state, inf);
}
}
}, url, null, null, true);
TorrentDownloaderManager.getInstance().add(downloader);
}
/**
* downloads a torrent on the local file system to the default save directory
* @param fileName
*/
public void downloadTorrent(String fileName)
{
downloadTorrent(fileName, getDefaultSaveDirectory());
}
/**
* downloads the remote torrent file. once we have downloaded the .torrent file, we
* pass the data to the downloadTorrent() method for further processing
*/
public void downloadRemoteTorrent(String url) {
downloadRemoteTorrent(url, getDefaultSaveDirectory());
}
/**
* instantiates each of the plugin commands and registers t
*/
private void registerPluginCommands() {
Class clazz;
for (Iterator iter = pluginCommands.iterator(); iter.hasNext();) {
clazz = (Class) iter.next();
try {
IConsoleCommand command = (IConsoleCommand) clazz.newInstance();
registerCommand(command);
} catch (InstantiationException e)
{
out.println("Error while registering plugin command: " + clazz.getName() + ":" + e.getMessage());
} catch (IllegalAccessException e) {
out.println("Error while registering plugin command: " + clazz.getName() + ":" + e.getMessage());
}
}
}
protected void
registerAlertHandler()
{
org.gudy.azureus2.core3.logging.Logger.addListener(new ILogAlertListener() {
private java.util.Set history = Collections.synchronizedSet( new HashSet());
public void alertRaised(LogAlert alert) {
if (!alert.repeatable) {
if ( history.contains( alert.text )){
return;
}
history.add( alert.text );
}
out.println( alert.text );
if (alert.err != null)
alert.err.printStackTrace( out );
}
});
}
/**
* registers the commands available to be executed from this console
*/
protected void registerCommands()
{
registerCommand(new XML());
registerCommand(new Hack());
registerCommand(new AddFind());
registerCommand(new Create());
registerCommand(new TorrentCheck());
registerCommand(new TorrentQueue());
registerCommand(new TorrentRemove());
registerCommand(new TorrentArchive());
registerCommand(new TorrentStart());
registerCommand(new TorrentStop());
registerCommand(new TorrentHost());
registerCommand(new TorrentPublish());
registerCommand(new TorrentForceStart());
registerCommand(new TorrentLog());
registerCommand(new Log());
registerCommand(new Move());
registerCommand(new RunState());
registerCommand(new Share());
registerCommand(new Set());
registerCommand(new Show());
registerCommand(new CommandUI());
registerCommand(new CommandLogout());
registerCommand(new CommandQuit());
registerCommand(new CommandHelp());
registerCommand(new Alias());
registerCommand(new Priority());
registerCommand(new Plugin());
registerCommand(new Pairing());
registerCommand(new Archive());
}
/**
* @param set
*/
protected void registerCommand(IConsoleCommand command)
{
for (Iterator iter = command.getCommandNames().iterator(); iter.hasNext();) {
String cmdName = (String) iter.next();
commands.put( cmdName, command);
}
helpItems.add(command);
}
protected void unregisterCommand(IConsoleCommand command)
{
for (Iterator iter = command.getCommandNames().iterator(); iter.hasNext();) {
String cmdName = (String) iter.next();
if( command.equals(commands.get(cmdName)) )
commands.remove( cmdName );
}
helpItems.remove(command);
}
protected void unregisterCommand(String commandName)
{
IConsoleCommand cmd = (IConsoleCommand)commands.get(commandName);
if( cmd == null )
return;
// check if there are any more commands registered to this command object,
// otherwise remove it
int numCommands = 0;
for (Iterator iter = commands.entrySet().iterator(); iter.hasNext();) {
Map.Entry entry = (Map.Entry) iter.next();
if( cmd.equals(entry.getValue()) )
numCommands++;
}
if( numCommands == 1)
unregisterCommand(cmd);
else
commands.remove(commandName);
}
public ConsoleInput(String con, AzureusCore _azureus_core, InputStream _in, PrintStream _out, Boolean _controlling) {
this(con, _azureus_core, new InputStreamReader(_in), _out, _controlling);
}
private static void quit(boolean finish) {
if (finish)
UIConst.shutdown();
}
private class CommandHelp extends IConsoleCommand
{
public CommandHelp()
{
super("help", "?");
}
public String getCommandDescriptions() {
return("help [torrents]\t\t\t?\tShow this help. 'torrents' shows info about the show torrents display.");
}
public void execute(String commandName, ConsoleInput ci, List args)
{
if (args.isEmpty()){
printconsolehelp(ci.out);
} else {
String subcommand = (String) args.get(0);
IConsoleCommand cmd = (IConsoleCommand) commands.get(subcommand);
if( cmd != null )
{
List newargs = new ArrayList(args);
newargs.remove(0);
cmd.printHelp(ci.out, newargs);
//if (cmd.getHelpExtra())
}
else if (subcommand.equalsIgnoreCase("torrents") || subcommand.equalsIgnoreCase("t")) {
ci.out.println("> -----");
ci.out.println("# [state] PercentDone Name (Filesize) ETA\r\n\tDownSpeed / UpSpeed\tDownloaded/Uploaded\tConnectedSeeds(total) / ConnectedPeers(total)");
ci.out.println();
ci.out.println("States:");
ci.out.println(" > Downloading");
ci.out.println(" * Seeding");
ci.out.println(" ! Stopped");
ci.out.println(" . Waiting (for allocation/checking)");
ci.out.println(" : Ready");
ci.out.println(" - Queued");
ci.out.println(" A Allocating");
ci.out.println(" C Checking");
ci.out.println(" E Error");
ci.out.println(" I Initializing");
ci.out.println(" ? Unknown");
ci.out.println("> -----");
} else
printconsolehelp(ci.out);
}
}
}
public void printwelcome()
{
out.println("Running " + Constants.APP_NAME + " " + Constants.AZUREUS_VERSION + "...");
out.println("Using configuration settings from:");
out.println(" " + SystemProperties.getUserPath());
}
public void printconsolehelp()
{
printconsolehelp(out);
}
private void printconsolehelp(PrintStream os) {
os.println("> -----");
os.println("Available console commands (use help <command> for more details):");
os.println();
ArrayList cmd_lines = new ArrayList();
Iterator itr = helpItems.iterator();
while (itr.hasNext()) {
StringBuffer line_so_far = new StringBuffer("[");
IConsoleCommand cmd = (IConsoleCommand)itr.next();
String short_name = cmd.getShortCommandName();
if (short_name != null) {
line_so_far.append(short_name);
}
line_so_far.append("] ");
line_so_far.append(cmd.getCommandName());
cmd_lines.add(line_so_far.toString());
}
TextWrap.printList(cmd_lines.iterator(), os, " ");
os.println("> -----");
}
private static class CommandQuit extends IConsoleCommand
{
public CommandQuit()
{
super("quit");
}
public String getCommandDescriptions() {
return("quit\t\t\t\t\tShutdown Azureus");
}
public void execute(String commandName, ConsoleInput ci, List args) {
if (ci.controlling) {
ci.running = false;
ci.out.print( "Exiting....." );
quit( true );
ci.out.println( "OK" );
}
else {
if (args.isEmpty() || (!args.get(0).toString().equalsIgnoreCase("IAMSURE"))) {
ci.out.println("> The 'quit' command exits azureus. Since this is a non-controlling shell thats probably not what you wanted. Use 'logout' to quit it or 'quit iamsure' to really exit azureus.");
}
else {
ci.out.print( "Exiting....." );
quit( true );
ci.out.println( "OK" );
}
}
}
}
private static class CommandLogout extends IConsoleCommand
{
public CommandLogout()
{
super("logout");
}
public String getCommandDescriptions() {
return "logout\t\t\t\t\tLog out of the CLI";
}
public void execute(String commandName, ConsoleInput ci, List args) {
try {
if ( !ci.controlling ){
// we never want to close System.out - could be remote command exec
if ( ci.out != System.out ){
ci.out.println( "Logged out" );
ci.out.close();
}
ci.br.close();
}
}catch (IOException ignored){
}finally{
ci.running = false;
}
}
}
private static class CommandUI extends IConsoleCommand
{
public CommandUI()
{
super("ui", "u");
}
public String getCommandDescriptions() {
return("ui <interface>\t\t\tu\tStart additional user interface.");
}
public void execute(String commandName, ConsoleInput ci, List args) {
if (!args.isEmpty()){
UIConst.startUI(args.get(0).toString(), null);
} else {
ci.out.println("> Missing subcommand for 'ui'\r\n> ui syntax: ui <interface>");
}
}
}
public boolean invokeCommand(String command, List cargs) {
if( command.startsWith("\\") )
command = command.substring(1);
else if( aliases.containsKey(command) )
{
List list = br.parseCommandLine(aliases.getProperty(command));
String newCommand = list.remove(0).toString().toLowerCase();
list.addAll( cargs );
return invokeCommand(newCommand, list);
}
if (commands.containsKey(command)) {
IConsoleCommand cmd = (IConsoleCommand) commands.get(command);
try {
if( cargs == null )
cargs = new ArrayList();
cmd.execute(command, this, cargs);
return true;
} catch (Exception e)
{
out.println("> Invoking Command '"+command+"' failed. Exception: "+ Debug.getNestedExceptionMessage(e));
return false;
}
} else
return false;
}
public void run() {
List comargs;
running = true;
while (running) {
try {
String line = br.readLine();
comargs = br.parseCommandLine(line);
} catch (Exception e) {
out.println("Stopping console input reader because of exception: " + e.getMessage());
running = false;
break;
}
if (!comargs.isEmpty()) {
String command = ((String) comargs.get(0)).toLowerCase();
if( ".".equals(command) )
{
if (oldcommand.size() > 0 ) {
comargs.clear();
comargs.addAll(oldcommand);
command = ((String) comargs.get(0)).toLowerCase();
} else {
out.println("No old command. Remove commands are not repeated to prevent errors");
}
}
oldcommand.clear();
oldcommand.addAll(comargs);
comargs.remove(0);
try {
if (!invokeCommand(command, comargs)) {
out.println("> Command '" + command + "' unknown (or . used without prior command)");
}
} catch (Throwable e)
{
out.println("Exception occurred when executing command: '" + command + "'");
e.printStackTrace(out);
}
}
}
}
private File getAliasesFile()
{
PluginInterface pi = azureus_core.getPluginManager().getDefaultPluginInterface();
String azureusUserDir = pi.getUtilities().getAzureusUserDir();
return new File(azureusUserDir, ALIASES_CONFIG_FILE);
}
/**
* read in the aliases from the alias properties file
* @throws IOException
*/
private void loadAliases() throws IOException
{
File aliasesFile = getAliasesFile();
out.println("Attempting to load aliases from: " + aliasesFile.getCanonicalPath());
if ( aliasesFile.exists() )
{
FileInputStream fr = new FileInputStream(aliasesFile);
aliases.clear();
try {
aliases.load(fr);
} finally {
fr.close();
}
}
}
/**
* writes the aliases back out to the alias file
*/
public void saveAliases() {
File aliasesFile = getAliasesFile();
try {
out.println("Saving aliases to: " + aliasesFile.getCanonicalPath());
FileOutputStream fo = new FileOutputStream(aliasesFile);
try{
aliases.store(fo, "This aliases file was automatically written by Azureus");
}finally{
fo.close();
}
} catch (IOException e) {
out.println("> Error saving aliases to " + aliasesFile.getPath() + ":" + e.getMessage());
}
}
/**
* @return Returns the userProfile.
*/
public UserProfile getUserProfile() {
return userProfile;
}
/**
* returns the default directory that torrents should be saved to unless otherwise specified
* @return
*/
public String getDefaultSaveDirectory() {
try {
String saveDir = getUserProfile().getDefaultSaveDirectory();
if( saveDir == null )
{
saveDir = COConfigurationManager.getDirectoryParameter("Default save path");
if( saveDir == null || saveDir.length() == 0 )
saveDir = ".";
}
return saveDir;
} catch (Exception e)
{
e.printStackTrace();
return ".";
}
}
protected void
registerUpdateChecker()
{
boolean check_at_start = COConfigurationManager.getBooleanParameter( "update.start", true );
if ( !check_at_start ){
return;
}
// we've got to disable the auto-update components as we're not using them (yet...)
PluginManager pm = azureus_core.getPluginManager();
pm.getPluginInstaller().addListener(
new PluginInstallerListener()
{
public boolean
installRequest(
String reason,
InstallablePlugin plugin )
throws PluginException
{
out.println( "Plugin installation request for '" + plugin.getName() + "' - " + reason );
String desc = plugin.getDescription();
String[] bits = desc.split( "\n" );
for (int i=0;i<bits.length;i++){
out.println( "\t" + bits[i]);
}
return( true );
}
});
PluginInterface pi = pm.getPluginInterfaceByClass( CorePatchChecker.class );
if ( pi != null ){
pi.getPluginState().setDisabled( true );
}
pi = pm.getPluginInterfaceByClass( UpdaterUpdateChecker.class );
if ( pi != null ){
pi.getPluginState().setDisabled( true );
}
UpdateManager update_manager = azureus_core.getPluginManager().getDefaultPluginInterface().getUpdateManager();
final UpdateCheckInstance checker = update_manager.createUpdateCheckInstance();
checker.addListener(
new UpdateCheckInstanceListener()
{
public void
cancelled(
UpdateCheckInstance instance )
{
}
public void
complete(
UpdateCheckInstance instance )
{
int num_updates = 0;
Update[] updates = instance.getUpdates();
for (int i=0;i<updates.length;i++){
Update update = updates[i];
num_updates++;
out.println( "Update available for '" + update.getName() + "', new version = " + update.getNewVersion());
String[] descs = update.getDescription();
for (int j=0;j<descs.length;j++){
out.println( "\t" + descs[j] );
}
if ( update.isMandatory()){
out.println( "**** This is a mandatory update, other updates can not proceed until this is performed ****" );
}
}
// need to cancel this otherwise it sits there blocking other installer operations
checker.cancel();
if ( num_updates > 0 ){
out.println( "Apply these updates with the 'plugin update' command" );
}
}
});
checker.start();
}
public AzureusCore
getCore()
{
return( azureus_core );
}
public GlobalManager
getGlobalManager()
{
return( azureus_core.getGlobalManager());
}
}