/*
* Copyright (C) The Apache Software Foundation. All rights reserved.
*
* This software is published under the terms of the Apache Software License
* version 1.1, a copy of which has been included with this distribution in
* the LICENSE file.
*/
package org.apache.james.remotemanager;
import org.apache.avalon.cornerstone.services.connection.ConnectionHandler;
import org.apache.avalon.cornerstone.services.scheduler.PeriodicTimeTrigger;
import org.apache.avalon.cornerstone.services.scheduler.Target;
import org.apache.avalon.cornerstone.services.scheduler.TimeScheduler;
import org.apache.avalon.framework.component.ComponentException;
import org.apache.avalon.framework.component.ComponentManager;
import org.apache.avalon.framework.component.Composable;
import org.apache.avalon.framework.configuration.Configurable;
import org.apache.avalon.framework.configuration.Configuration;
import org.apache.avalon.framework.configuration.ConfigurationException;
import org.apache.james.BaseConnectionHandler;
import org.apache.james.Constants;
import org.apache.james.services.*;
import org.apache.james.userrepository.DefaultUser;
import org.apache.mailet.MailAddress;
import javax.mail.internet.ParseException;
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.io.PrintWriter;
import java.net.Socket;
import java.util.HashMap;
import java.util.Iterator;
import java.util.StringTokenizer;
/**
* Provides a really rude network interface to administer James.
* Allow to add accounts.
* TODO: -improve protocol
* -add remove user
* -much more...
* @version 1.0.0, 24/04/1999
* @author Federico Barbieri <scoobie@pop.systemy.it>
* @author <a href="mailto:donaldp@apache.org">Peter Donald</a>
* @author <a href="mailto:charles@benett1.demon.co.uk">Charles Benett</a>
*
* Last changed by: $Author: serge $ on $Date: 2002/04/17 04:23:36 $
* $Revision: 1.10 $
*
*/
public class RemoteManagerHandler
extends BaseConnectionHandler
implements ConnectionHandler, Composable, Configurable, Target {
private UsersStore usersStore;
private UsersRepository users;
private boolean inLocalUsers = true;
private TimeScheduler scheduler;
private MailServer mailServer;
private BufferedReader in;
private PrintWriter out;
private HashMap admaccount = new HashMap();
private Socket socket;
public void configure( final Configuration configuration )
throws ConfigurationException {
timeout = configuration.getChild( "connectiontimeout" ).getValueAsInteger( 120000 );
final Configuration admin = configuration.getChild( "administrator_accounts" );
final Configuration[] accounts = admin.getChildren( "account" );
for ( int i = 0; i < accounts.length; i++ )
{
admaccount.put( accounts[ i ].getAttribute( "login" ),
accounts[ i ].getAttribute( "password" ) );
}
}
public void compose( final ComponentManager componentManager )
throws ComponentException {
scheduler = (TimeScheduler)componentManager.
lookup( "org.apache.avalon.cornerstone.services.scheduler.TimeScheduler" );
mailServer = (MailServer)componentManager.
lookup( "org.apache.james.services.MailServer" );
usersStore = (UsersStore)componentManager.
lookup( "org.apache.james.services.UsersStore" );
users = usersStore.getRepository("LocalUsers");;
}
/**
* Handle a connection.
* This handler is responsible for processing connections as they occur.
*
* @param connection the connection
* @exception IOException if an error reading from socket occurs
* @exception ProtocolException if an error handling connection occurs
*/
public void handleConnection( final Socket connection )
throws IOException {
/*
if( admaccount.isEmpty() ) {
getLogger().warn("No Administrative account defined");
getLogger().warn("RemoteManager failed to be handled");
return;
}
*/
final PeriodicTimeTrigger trigger = new PeriodicTimeTrigger( timeout, -1 );
scheduler.addTrigger( this.toString(), trigger, this );
socket = connection;
String remoteHost = socket.getInetAddress().getHostName();
String remoteIP = socket.getInetAddress().getHostAddress();
try {
in = new BufferedReader(new InputStreamReader( socket.getInputStream() ));
out = new PrintWriter( socket.getOutputStream(), true);
getLogger().info( "Access from " + remoteHost + "(" + remoteIP + ")" );
out.println( "JAMES RemoteAdministration Tool " + Constants.SOFTWARE_VERSION );
out.println("Please enter your login and password");
String login = null;
String password = null;
do {
scheduler.resetTrigger(this.toString());
if (login != null) {
final String message = "Login failed for " + login;
out.println( message );
getLogger().info( message );
}
out.println("Login id:");
login = in.readLine().trim();
out.println("Password:");
password = in.readLine().trim();
} while (!password.equals(admaccount.get(login)) || password.length() == 0);
scheduler.resetTrigger(this.toString());
out.println( "Welcome " + login + ". HELP for a list of commands" );
getLogger().info("Login for " + login + " succesful");
try {
while (parseCommand(in.readLine())) {
scheduler.resetTrigger(this.toString());
}
} catch (IOException ioe) {
//We can cleanly ignore this as it's probably a socket timeout
} catch (Throwable thr) {
System.out.println("Exception: " + thr.getMessage());
thr.printStackTrace();
}
getLogger().info("Logout for " + login + ".");
socket.close();
} catch ( final IOException e ) {
out.println("Error. Closing connection");
out.flush();
getLogger().error( "Exception during connection from " + remoteHost +
" (" + remoteIP + ")");
}
scheduler.removeTrigger(this.toString());
}
public void targetTriggered( final String triggerName ) {
getLogger().error("Connection timeout on socket");
try {
out.println("Connection timeout. Closing connection");
socket.close();
} catch ( final IOException ioe ) {
}
}
private boolean parseCommand( String command ) {
if (command == null) return false;
StringTokenizer commandLine = new StringTokenizer(command.trim(), " ");
int arguments = commandLine.countTokens();
if (arguments == 0) {
return true;
} else if(arguments > 0) {
command = commandLine.nextToken();
}
String argument = (String) null;
if(arguments > 1) {
argument = commandLine.nextToken();
}
String argument1 = (String) null;
if(arguments > 2) {
argument1 = commandLine.nextToken();
}
if (command.equalsIgnoreCase("ADDUSER")) {
String username = argument;
String passwd = argument1;
try {
if (username.equals("") || passwd.equals("")) {
out.println("usage: adduser [username] [password]");
return true;
}
} catch (NullPointerException e) {
out.println("usage: adduser [username] [password]");
return true;
}
boolean success = false;
if (users.contains(username)) {
out.println("user " + username + " already exist");
}
else if ( inLocalUsers ) {
success = mailServer.addUser(username, passwd);
}
else {
DefaultUser user = new DefaultUser(username, "SHA");
user.setPassword(passwd);
success = users.addUser(user);
}
if ( success ) {
out.println("User " + username + " added");
getLogger().info("User " + username + " added");
}
else {
out.println("Error adding user " + username);
getLogger().info("Error adding user " + username);
}
out.flush();
} else if (command.equalsIgnoreCase("SETPASSWORD")) {
if (argument == null || argument1 == null) {
out.println("usage: setpassword [username] [password]");
return true;
}
String username = argument;
String passwd = argument1;
if (username.equals("") || passwd.equals("")) {
out.println("usage: adduser [username] [password]");
return true;
}
User user = users.getUserByName(username);
if (user == null) {
out.println("No such user");
return true;
}
boolean success;
success = user.setPassword(passwd);
if (success){
users.updateUser(user);
out.println("Password for " + username + " reset");
getLogger().info("Password for " + username + " reset");
} else {
out.println("Error resetting password");
getLogger().info("Error resetting password");
}
out.flush();
return true;
} else if (command.equalsIgnoreCase("DELUSER")) {
String user = argument;
if (user.equals("")) {
out.println("usage: deluser [username]");
return true;
}
try {
users.removeUser(user);
} catch (Exception e) {
out.println("Error deleting user " + user + " : " + e.getMessage());
return true;
}
out.println("User " + user + " deleted");
getLogger().info("User " + user + " deleted");
} else if (command.equalsIgnoreCase("LISTUSERS")) {
out.println("Existing accounts " + users.countUsers());
for (Iterator it = users.list(); it.hasNext();) {
out.println("user: " + (String) it.next());
}
} else if (command.equalsIgnoreCase("COUNTUSERS")) {
out.println("Existing accounts " + users.countUsers());
} else if (command.equalsIgnoreCase("VERIFY")) {
String user = argument;
if (user.equals("")) {
out.println("usage: verify [username]");
return true;
}
if (users.contains(user)) {
out.println("User " + user + " exist");
} else {
out.println("User " + user + " does not exist");
}
} else if (command.equalsIgnoreCase("HELP")) {
out.println("Currently implemented commans:");
out.println("help display this help");
out.println("listusers display existing accounts");
out.println("countusers display the number of existing accounts");
out.println("adduser [username] [password] add a new user");
out.println("verify [username] verify if specified user exist");
out.println("deluser [username] delete existing user");
out.println("setpassword [username] [password] sets a user's password");
out.println("setalias [username] [alias] sets a user's alias");
out.println("unsetalias [username] removes a user's alias");
out.println("setforwarding [username] [emailaddress] forwards a user's email to another account");
out.println("user [repositoryname] change to another user repository");
out.println("shutdown kills the current JVM (convenient when James is run as a daemon)");
out.println("quit close connection");
out.flush();
} else if (command.equalsIgnoreCase("SETALIAS")) {
if (argument == null || argument1 == null) {
out.println("usage: setalias [username] [alias]");
return true;
}
String username = argument;
String alias = argument1;
if (username.equals("") || alias.equals("")) {
out.println("usage: adduser [username] [alias]");
return true;
}
JamesUser user = (JamesUser) users.getUserByName(username);
if (user == null) {
out.println("No such user");
return true;
}
JamesUser aliasUser = (JamesUser) users.getUserByName(alias);
if (aliasUser == null) {
out.println("Alias unknown to server"
+ " - create that user first.");
return true;
}
boolean success;
success = user.setAlias(alias);
if (success){
user.setAliasing(true);
users.updateUser(user);
out.println("Alias for " + username + " set to:" + alias);
getLogger().info("Alias for " + username + " set to:" + alias);
} else {
out.println("Error setting alias");
getLogger().info("Error setting alias");
}
out.flush();
return true;
} else if (command.equalsIgnoreCase("SETFORWARDING")) {
if (argument == null || argument1 == null) {
out.println("usage: setforwarding [username] [emailaddress]");
return true;
}
String username = argument;
String forward = argument1;
if (username.equals("") || forward.equals("")) {
out.println("usage: adduser [username] [emailaddress]");
return true;
}
// Verify user exists
User baseuser = users.getUserByName(username);
if (baseuser == null) {
out.println("No such user");
return true;
}
else if (! (baseuser instanceof JamesUser ) ) {
out.println("Can't set forwarding for this user type.");
return true;
}
JamesUser user = (JamesUser)baseuser;
// Veriy acceptable email address
MailAddress forwardAddr;
try {
forwardAddr = new MailAddress(forward);
} catch(ParseException pe) {
out.println("Parse exception with that email address: "
+ pe.getMessage());
out.println("Forwarding address not added for " + username);
return true;
}
boolean success;
success = user.setForwardingDestination(forwardAddr);
if (success){
user.setForwarding(true);
users.updateUser(user);
out.println("Forwarding destination for " + username
+ " set to:" + forwardAddr.toString());
getLogger().info("Forwarding destination for " + username
+ " set to:" + forwardAddr.toString());
} else {
out.println("Error setting forwarding");
getLogger().info("Error setting forwarding");
}
out.flush();
return true;
} else if (command.equalsIgnoreCase("UNSETALIAS")) {
if (argument == null) {
out.println("usage: unsetalias [username]");
return true;
}
String username = argument;
if (username.equals("")) {
out.println("usage: adduser [username]");
return true;
}
JamesUser user = (JamesUser) users.getUserByName(username);
if (user == null) {
out.println("No such user");
return true;
}
if (user.getAliasing()){
user.setAliasing(false);
users.updateUser(user);
out.println("Alias for " + username + " unset");
getLogger().info("Alias for " + username + " unset");
} else {
out.println("Aliasing not active for" + username);
getLogger().info("Aliasing not active for" + username);
}
out.flush();
return true;
} else if (command.equalsIgnoreCase("USE")) {
if (argument == null || argument.equals("")) {
out.println("usage: use [repositoryName]");
return true;
}
String repositoryName = argument;
UsersRepository repos = usersStore.getRepository(repositoryName);
if ( repos == null ) {
out.println("no such repository");
return true;
}
else {
users = repos;
out.println("Changed to repository '" + repositoryName + "'.");
if ( repositoryName.equalsIgnoreCase("localusers") ) {
inLocalUsers = true;
}
else {
inLocalUsers = false;
}
return true;
}
} else if (command.equalsIgnoreCase("QUIT")) {
out.println("bye");
return false;
} else if (command.equalsIgnoreCase("SHUTDOWN")) {
out.println("shuting down, bye bye");
System.exit(0);
return false;
} else {
out.println("unknown command " + command);
}
return true;
}
}