org/objectweb/proactive/core/process/AbstractExternalProcess.java

/* 
 * ################################################################
 * 
 * ProActive: The Java(TM) library for Parallel, Distributed, 
 *            Concurrent computing with Security and Mobility
 * 
 * Copyright (C) 1997-2007 INRIA/University of Nice-Sophia Antipolis
 * Contact: proactive@objectweb.org
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or any later version.
 *  
 * This library 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
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307
 * USA
 *  
 *  Initial developer(s):               The ProActive Team
 *                        http://www.inria.fr/oasis/ProActive/contacts.html
 *  Contributor(s): 
 * 
 * ################################################################
 */ 
package org.objectweb.proactive.core.process;

import org.apache.log4j.Logger;

import org.objectweb.proactive.core.process.filetransfer.CopyProtocol;
import org.objectweb.proactive.core.process.filetransfer.FileTransferWorkShop;
import org.objectweb.proactive.core.util.RemoteProcessMessageLogger;
import org.objectweb.proactive.core.util.log.Loggers;
import org.objectweb.proactive.core.util.log.ProActiveLogger;

import java.io.IOException;


public abstract class AbstractExternalProcess extends AbstractUniversalProcess
    implements ExternalProcess {
    protected static Logger clogger = ProActiveLogger.getLogger(Loggers.DEPLOYMENT_PROCESS);
    protected static Logger fileTransferLogger = ProActiveLogger.getLogger(Loggers.DEPLOYMENT_FILETRANSFER);
    protected static final boolean IS_WINDOWS_SYSTEM = System.getProperty(
            "os.name").toLowerCase().startsWith("win");
    protected Process externalProcess;
    private volatile boolean shouldRun = true;
    public static final int NO_COMPOSITION = 0;
    protected boolean closeStream = false;
    protected RemoteProcessMessageLogger inputMessageLogger;
    protected RemoteProcessMessageLogger errorMessageLogger;
    protected MessageSink outputMessageSink;
    private ThreadActivityMonitor inThreadMonitor;
    private ThreadActivityMonitor errThreadMonitor;
    private FileTransferWorkShop ftsDeploy = null;
    private FileTransferWorkShop ftsRetrieve = null;
    protected String FILE_TRANSFER_DEFAULT_PROTOCOL = "dummy";

    //Used to determine if a File Transfer is required to the Nodes deployed from
    //the VirtualNode. @see VirtualNodeImpl
    private boolean requiresFileTransferDeployOnNodeCreation = false;

    //
    // -- CONSTRUCTORS -----------------------------------------------
    //
    protected AbstractExternalProcess() {
    }

    public AbstractExternalProcess(RemoteProcessMessageLogger messageLogger) {
        this(messageLogger, messageLogger, null);
    }

    public AbstractExternalProcess(
        RemoteProcessMessageLogger inputMessageLogger,
        RemoteProcessMessageLogger errorMessageLogger) {
        this(inputMessageLogger, errorMessageLogger, null);
    }

    public AbstractExternalProcess(
        RemoteProcessMessageLogger inputMessageLogger,
        RemoteProcessMessageLogger errorMessageLogger,
        MessageSink outputMessageSink) {
        this.inputMessageLogger = inputMessageLogger;
        this.errorMessageLogger = errorMessageLogger;
        this.outputMessageSink = outputMessageSink;
    }

    //
    // -- PUBLIC METHODS -----------------------------------------------
    //
    //
    // -- implements ExternalProcess -----------------------------------------------
    //
    public void closeStream() {
        this.closeStream = true;
    }

    public RemoteProcessMessageLogger getInputMessageLogger() {
        return inputMessageLogger;
    }

    public RemoteProcessMessageLogger getErrorMessageLogger() {
        return errorMessageLogger;
    }

    public MessageSink getOutputMessageSink() {
        return outputMessageSink;
    }

    public void setInputMessageLogger(
        RemoteProcessMessageLogger inputMessageLogger) {
        checkStarted();
        this.inputMessageLogger = inputMessageLogger;
    }

    public void setErrorMessageLogger(
        RemoteProcessMessageLogger errorMessageLogger) {
        checkStarted();
        this.errorMessageLogger = errorMessageLogger;
    }

    public void setOutputMessageSink(MessageSink outputMessageSink) {
        checkStarted();
        this.outputMessageSink = outputMessageSink;
    }

    public FileTransferWorkShop getFileTransferWorkShopDeploy() {
        if (ftsDeploy == null) {
            ftsDeploy = new FileTransferWorkShop(getFileTransferDefaultCopyProtocol());
        }

        return ftsDeploy;
    }

    public FileTransferWorkShop getFileTransferWorkShopRetrieve() {
        if (ftsRetrieve == null) {
            ftsRetrieve = new FileTransferWorkShop(getFileTransferDefaultCopyProtocol());
        }

        return ftsRetrieve;
    }

    public String getFileTransferDefaultCopyProtocol() {
        return FILE_TRANSFER_DEFAULT_PROTOCOL;
    }

    public int getCompositionType() {
        return NO_COMPOSITION;
    }

    //
    // -- PROTECTED METHODS -----------------------------------------------
    //
    protected abstract String buildCommand();

    protected String buildEnvironmentCommand() {
        if (environment == null) {
            return "";
        }
        if (IS_WINDOWS_SYSTEM) {
            return buildWindowsEnvironmentCommand();
        } else {
            return buildUnixEnvironmentCommand();
        }
    }

    protected String buildWindowsEnvironmentCommand() {
        StringBuilder sb = new StringBuilder();
        for (int i = 0; i < environment.length; i++) {
            inputMessageLogger.log("      exporting variable " +
                environment[i]);
            sb.append("set ");
            sb.append(environment[i]);
            sb.append(" ; ");
        }
        return sb.toString();
    }

    protected String buildUnixEnvironmentCommand() {
        StringBuilder sb = new StringBuilder();
        for (int i = 0; i < environment.length; i++) {
            inputMessageLogger.log("      exporting variable " +
                environment[i]);
            sb.append("export ");
            sb.append(environment[i]);
            sb.append(" ; ");
        }
        return sb.toString();
    }

    protected void internalStartProcess(String commandToExecute)
        throws java.io.IOException {
        try {
            shouldRun = true;
            externalProcess = Runtime.getRuntime().exec(commandToExecute);
            java.io.BufferedReader in = new java.io.BufferedReader(new java.io.InputStreamReader(
                        externalProcess.getInputStream()));
            java.io.BufferedReader err = new java.io.BufferedReader(new java.io.InputStreamReader(
                        externalProcess.getErrorStream()));
            java.io.BufferedWriter out = new java.io.BufferedWriter(new java.io.OutputStreamWriter(
                        externalProcess.getOutputStream()));
            handleProcess(in, out, err);
        } catch (java.io.IOException e) {
            isFinished = true;
            throw e;
        }
    }

    protected void internalStopProcess() {
        shouldRun = false;

        if (externalProcess != null) {
            externalProcess.destroy();
        }
        if (outputMessageSink != null) {
            outputMessageSink.setMessage(null);
        }
    }

    protected int internalWaitFor() throws InterruptedException {
        return externalProcess.waitFor();
    }

    protected int internalExitValue() throws IllegalThreadStateException {
        return externalProcess.exitValue();
    }

    protected void internalStartFileTransfer(FileTransferWorkShop fts) {
        CopyProtocol[] copyProtocol = fts.getCopyProtocols();
        boolean success = false;

        long beginning = System.currentTimeMillis();
        long end = beginning;

        /*
           if (fileTransferLogger.isDebugEnabled()) {
               fileTransferLogger.debug(
                   "Using the following FileTransferWorkShop:\n" + fts);
           }
         */
        if (!fts.check()) {
            return; //No files to transfer or some error.
        }

        /* Try all the protocols for this FileTransferStructure
         * until one of them is successful */
        for (int i = 0; (i < copyProtocol.length) && !success; i++) {
            fileTransferLogger.info("Trying copyprotocol: " +
                copyProtocol[i].getProtocolName());
            if (!copyProtocol[i].checkProtocol()) {
                logger.error("Protocol check failed");
                continue;
            }

            //If ProActive File Transfer will be used then we stop trying
            //more protocols. The file transfer will take place when
            //the nodes register back to this runtime, in the VirtualNodeImpl class.
            if (copyProtocol[i].getProtocolName().equalsIgnoreCase("pftp")) {
                if (fileTransferLogger.isDebugEnabled()) {
                    fileTransferLogger.debug(
                        "ProActive File Transfer will be used later on.");
                }

                //TODO transfer this info to the virtual node level
                success = true;
                requiresFileTransferDeployOnNodeCreation = true;
            }
            //it's an internal protocol
            else if (copyProtocol[i].isDefaultProtocol() &&
                    copyProtocol[i].isDummyProtocol()) {
                if (fileTransferLogger.isDebugEnabled()) {
                    fileTransferLogger.debug(
                        "Trying protocol internal filetransfer");
                }

                success = internalFileTransferDefaultProtocol();
            }
            //else simply try to start the external copy protocol
            else {
                success = copyProtocol[i].startFileTransfer();
            }
        }

        end = System.currentTimeMillis();

        if (fileTransferLogger.isDebugEnabled()) {
            fileTransferLogger.debug("FileTransfer spent:" + (end - beginning) +
                "[ms]");
        }

        if (!success) {
            fileTransferLogger.info("FileTransfer faild");
        }
    }

    protected boolean internalFileTransferDefaultProtocol() {
        //The default is false, to keep on trying the protocols
        return false;
    }

    public boolean isRequiredFileTransferDeployOnNodeCreation() {
        return requiresFileTransferDeployOnNodeCreation;
    }

    protected void handleProcess(java.io.BufferedReader in,
        java.io.BufferedWriter out, java.io.BufferedReader err) {
        if (closeStream) {
            try {
                //the sleep might be needed for processes that fail if
                // we close the in/err too early
                Thread.sleep(200);
                out.close();
                err.close();
                in.close();
            } catch (IOException e) {
                // TODO Auto-generated catch block
                e.printStackTrace();
            } catch (InterruptedException e) {
                // TODO Auto-generated catch block
                e.printStackTrace();
            }
        } else {
            handleInput(in);
            handleOutput(out);
            handleError(err);
        }
    }

    protected void handleInput(java.io.BufferedReader in) {
        if (inputMessageLogger == null) {
            return;
        }
        inThreadMonitor = new ThreadActivityMonitor();
        Runnable r = new ProcessInputHandler(in, inputMessageLogger,
                inThreadMonitor);
        Thread t = new Thread(r, "IN -> " + getShortName(getCommand(), 20));
        t.start();
    }

    protected void handleError(java.io.BufferedReader err) {
        if (errorMessageLogger == null) {
            return;
        }
        errThreadMonitor = new ThreadActivityMonitor();
        Runnable r = new ProcessInputHandler(err, errorMessageLogger,
                errThreadMonitor);
        Thread t = new Thread(r, "ERR -> " + getShortName(getCommand(), 20));
        t.start();
    }

    protected void handleOutput(java.io.BufferedWriter out) {
        if (outputMessageSink == null) {
            return;
        }

        //System.out.println("my output sink :"+outputMessageSink.toString());
        Runnable r = new ProcessOutputHandler(out, outputMessageSink);
        Thread t = new Thread(r, "OUT -> " + getShortName(getCommand(), 20));
        t.start();
    }

    //
    // -- PRIVATE METHODS -----------------------------------------------
    //
    private final String getShortName(String name, int length) {
        return name.substring(0, Math.min(name.length(), length));
    }

    private final void waitForMonitoredThread() {
        do {
            try {
                Thread.sleep(300);
            } catch (InterruptedException e) {
            }
        } while (errThreadMonitor.isActive() || inThreadMonitor.isActive());
    }

    private void writeObject(java.io.ObjectOutputStream out)
        throws java.io.IOException {
        if (isStarted) {
            //if the process is started, we have to remove the external process
            // which is now not Serializable:UnixProcess or WindowsProcess
            externalProcess = null;
        }
        out.defaultWriteObject();
    }

    //
    // -- INNER CLASSES -----------------------------------------------
    //
    private static class ThreadActivityMonitor implements java.io.Serializable {
        private boolean isActive;

        public boolean isActive() {
            return isActive;
        }

        public void setActive(boolean b) {
            isActive = b;
        }
    }

    public static class StandardOutputMessageLogger
        implements RemoteProcessMessageLogger, java.io.Serializable {
        public StandardOutputMessageLogger() {
            //messageLogger.addAppender(new ConsoleAppender(new PatternLayout("%-5p %m %n")));
        }

        public void log(String message) {
            messageLogger.info(message);
        }

        public void log(Throwable t) {
            t.printStackTrace();
        }

        public void log(String message, Throwable t) {
            messageLogger.info(message);
            t.printStackTrace();
        }
    }

    // end inner class StandardOutputMessageLogger

    public static class NullMessageLogger implements RemoteProcessMessageLogger,
        java.io.Serializable {
        public NullMessageLogger() {
        }

        public void log(String message) {
        }

        public void log(Throwable t) {
        }

        public void log(String message, Throwable t) {
        }
    }

    // end inner class NullMessageLogger

    public static class SimpleMessageSink implements MessageSink,
        java.io.Serializable {
        private String message;
        private boolean isActive = true;

        public synchronized String getMessage() {
            if (!isActive) {
                return null;
            }
            while ((message == null) && isActive) {
                try {
                    wait();
                } catch (InterruptedException e) {
                }
            }
            String messageToSend = message;
            message = null;
            notifyAll();
            return messageToSend;
        }

        public synchronized void setMessage(String messageToPost) {
            if (!isActive) {
                return;
            }
            while ((message != null) && isActive) {
                try {
                    wait();
                } catch (InterruptedException e) {
                }
            }
            if (messageToPost == null) {
                isActive = false;
            }
            this.message = messageToPost;
            notifyAll();
        }

        public synchronized boolean hasMessage() {
            return message != null;
        }

        public synchronized boolean isActive() {
            return isActive;
        }
    }

    // end inner class SimpleMessageSink

    protected class ProcessInputHandler implements Runnable {
        private java.io.BufferedReader in;
        private RemoteProcessMessageLogger logger;
        private ThreadActivityMonitor threadMonitor;

        public ProcessInputHandler(java.io.BufferedReader in,
            RemoteProcessMessageLogger logger,
            ThreadActivityMonitor threadMonitor) {
            this.in = in;
            this.logger = logger;
            this.threadMonitor = threadMonitor;
        }

        public void run() {
            if (AbstractExternalProcess.clogger.isDebugEnabled()) {
                AbstractExternalProcess.clogger.debug("Process started Thread=" +
                    Thread.currentThread().getName());
            }

            //
            try {
                while (shouldRun) {
                    threadMonitor.setActive(false);
                    //                    if (AbstractExternalProcess.clogger.isDebugEnabled()) {
                    //                                          AbstractExternalProcess.clogger.debug(
                    //                            "ProcessInputHandler before readLine()");
                    //                    }
                    String s = in.readLine();
                    if (AbstractExternalProcess.clogger.isDebugEnabled()) {
                        //                        AbstractExternalProcess.clogger.debug(
                        //                            "ProcessInputHandler after readLine() s=" + s);
                        AbstractExternalProcess.clogger.debug(s);
                    }

                    //
                    threadMonitor.setActive(true);
                    if (s == null) {
                        break;
                    } else {
                        logger.log(s);
                    }
                }
            } catch (java.io.IOException e) {
                logger.log(e);
            } finally {
                isFinished = true;
                threadMonitor.setActive(false);
                try {
                    in.close();
                } catch (java.io.IOException e) {
                    e.printStackTrace();
                }
                logger.log("Process finished Thread=" +
                    Thread.currentThread().getName());
            }
        }
    }

    // end inner class ProcessInputHandler

    protected class ProcessOutputHandler implements Runnable {
        private java.io.BufferedWriter out;
        private MessageSink messageSink;

        public ProcessOutputHandler(java.io.BufferedWriter out,
            MessageSink messageSink) {
            this.out = out;
            this.messageSink = messageSink;
        }

        public void run() {
            try {
                while (shouldRun) {
                    waitForMonitoredThread();
                    //System.out.println("ProcessOutputHandler before getMessage()");
                    String message = messageSink.getMessage();
                    if (message == null) {
                        break;
                    }
                    try {
                        out.write(message);
                        out.newLine();
                        out.flush();
                        //System.out.println("ProcessOutputHandler writing "+message);
                    } catch (java.io.IOException e) {
                        break;
                    }
                    message = null;
                }
            } finally {
                isFinished = true;
                waitForMonitoredThread();
                try {
                    out.close();
                } catch (java.io.IOException e) {
                    e.printStackTrace();
                }
            }
        }
    }

    // end inner class ProcessOutputHandler
}

---