+/*
+ * Copyright (C) 2007-2012 Mathieu Baudier
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
package org.argeo.slc.jsch;
import java.io.BufferedReader;
import java.io.BufferedWriter;
+import java.io.File;
+import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.util.Map;
import java.util.StringTokenizer;
+import org.apache.commons.exec.ExecuteStreamHandler;
import org.apache.commons.io.IOUtils;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.argeo.slc.SlcException;
+import org.argeo.slc.core.execution.ExecutionResources;
import org.argeo.slc.core.execution.tasks.SystemCall;
import org.springframework.core.io.Resource;
import org.springframework.util.StringUtils;
private Boolean forceShell = false;
private Map<String, String> env = new HashMap<String, String>();
private Resource stdIn = null;
+ private Resource stdOut = null;
+ private ExecutionResources executionResources;
+ private String user;
+
+ private ExecuteStreamHandler streamHandler = null;
+
+ private Integer lastExitStatus = null;
/**
* If set, stdout is written to it as a list of lines. Cleared before each
* run.
private Boolean logEvenIfStdOutLines = false;
private Boolean quiet = false;
+ public RemoteExec() {
+ }
+
+ public RemoteExec(SshTarget sshTarget, String cmd) {
+ setSshTarget(sshTarget);
+ setCommand(cmd);
+ }
+
public void run(Session session) {
List<String> commandsToUse = new ArrayList<String>(commands);
String commandToUse = command;
throw new SlcException("Cannot specify commands and script");
BufferedReader reader = null;
try {
- reader = new BufferedReader(new InputStreamReader(script
- .getInputStream()));
+ reader = new BufferedReader(new InputStreamReader(
+ script.getInputStream()));
String line = null;
while ((line = reader.readLine()) != null) {
if (!StringUtils.hasText(line))
}
if (forceShell) {
- if (commandToUse.indexOf(';') >= 0
- || commandToUse.indexOf('\n') >= 0) {
- StringTokenizer st = new StringTokenizer(commandToUse, ";\n");
+ // for the time being do not interpret both \n and ;
+ // priority to \n
+ // until we know how to parse ; within ""
+ if (commandToUse.indexOf('\n') >= 0) {
+ StringTokenizer st = new StringTokenizer(commandToUse, "\n");
+ while (st.hasMoreTokens()) {
+ String cmd = st.nextToken();
+ commandsToUse.add(cmd);
+ }
+ } else if (commandToUse.indexOf(';') >= 0) {
+ StringTokenizer st = new StringTokenizer(commandToUse, ";");
while (st.hasMoreTokens()) {
String cmd = st.nextToken();
commandsToUse.add(cmd);
commandToUse = null;
}
+ // run as user
+ if (user != null) {
+ if (commandsToUse.size() > 0) {
+ commandsToUse.add(0, "su - " + user);
+ commandsToUse.add("exit");
+ } else {
+ if (command.indexOf('\"') >= 0)
+ throw new SlcException(
+ "Don't know how to su a command with \", use shell instead.");
+ commandToUse = "su - " + user + " -c \"" + command + "\"";
+ }
+ }
+
// execute command(s)
if (commandToUse != null) {
if (commandsToUse.size() != 0)
log.debug("Run '" + command + "' on " + getSshTarget() + "...");
channel.connect();
- // write commands to shell
- if (stdIn != null) {
- Thread stdInThread = new Thread("Stdin " + getSshTarget()) {
- @Override
- public void run() {
- OutputStream out = null;
- try {
- out = channel.getOutputStream();
- IOUtils.copy(stdIn.getInputStream(), channel
- .getOutputStream());
- } catch (IOException e) {
- throw new SlcException("Cannot write stdin on "
- + getSshTarget(), e);
- } finally {
- IOUtils.closeQuietly(out);
- }
+ readStdIn(channel);
+ readStdOut(channel);
+
+ if (streamHandler != null){
+ streamHandler.start();
+ while(!channel.isClosed()){
+ try {
+ Thread.sleep(100);
+ } catch (Exception e) {
+ break;
}
- };
- stdInThread.start();
+ }
}
- readStdOut(channel);
+
checkExitStatus(channel);
channel.disconnect();
} catch (Exception e) {
}
}
- protected void readStdErr(final ChannelExec channel) {
- new Thread("stderr " + getSshTarget()) {
- public void run() {
- BufferedReader stdErr = null;
+ protected void readStdOut(Channel channel) {
+ try {
+ if (stdOut != null) {
+ OutputStream localStdOut = createOutputStream(stdOut);
+ try {
+ IOUtils.copy(channel.getInputStream(), localStdOut);
+ } finally {
+ IOUtils.closeQuietly(localStdOut);
+ }
+ } else if (streamHandler != null) {
+ if (channel.getInputStream() != null)
+ streamHandler.setProcessOutputStream(channel
+ .getInputStream());
+ } else {
+ BufferedReader stdOut = null;
try {
- InputStream in = channel.getErrStream();
- stdErr = new BufferedReader(new InputStreamReader(in));
+ InputStream in = channel.getInputStream();
+ stdOut = new BufferedReader(new InputStreamReader(in));
String line = null;
- while ((line = stdErr.readLine()) != null) {
- if (!line.trim().equals(""))
- log.error(line);
+ while ((line = stdOut.readLine()) != null) {
+ if (!line.trim().equals("")) {
+
+ if (stdOutLines != null) {
+ stdOutLines.add(line);
+ if (logEvenIfStdOutLines && !quiet)
+ log.info(line);
+ } else {
+ if (!quiet)
+ log.info(line);
+ }
+ }
}
- } catch (IOException e) {
- if (log.isDebugEnabled())
- log.error("Cannot read stderr from " + getSshTarget(),
- e);
} finally {
- IOUtils.closeQuietly(stdErr);
+ IOUtils.closeQuietly(stdOut);
}
}
- }.start();
+ } catch (IOException e) {
+ throw new SlcException("Cannot redirect stdout from "
+ + getSshTarget(), e);
+ }
}
- protected void readStdOut(Channel channel) {
- BufferedReader stdOut = null;
- try {
- InputStream in = channel.getInputStream();
- stdOut = new BufferedReader(new InputStreamReader(in));
- String line = null;
- while ((line = stdOut.readLine()) != null) {
- if (!line.trim().equals("")) {
- if (stdOutLines != null) {
- stdOutLines.add(line);
- if (logEvenIfStdOutLines && !quiet)
- log.info(line);
- } else {
- if (!quiet)
- log.info(line);
+ protected void readStdErr(final ChannelExec channel) {
+ if (streamHandler != null) {
+ try {
+ streamHandler.setProcessOutputStream(channel.getErrStream());
+ } catch (IOException e) {
+ throw new SlcException("Cannot read stderr from "
+ + getSshTarget(), e);
+ }
+ } else {
+ new Thread("stderr " + getSshTarget()) {
+ public void run() {
+ BufferedReader stdErr = null;
+ try {
+ InputStream in = channel.getErrStream();
+ stdErr = new BufferedReader(new InputStreamReader(in));
+ String line = null;
+ while ((line = stdErr.readLine()) != null) {
+ if (!line.trim().equals(""))
+ log.error(line);
+ }
+ } catch (IOException e) {
+ if (log.isDebugEnabled())
+ log.error("Cannot read stderr from "
+ + getSshTarget(), e);
+ } finally {
+ IOUtils.closeQuietly(stdErr);
+ }
+ }
+ }.start();
+ }
+ }
+
+ protected void readStdIn(final ChannelExec channel) {
+ if (stdIn != null) {
+ Thread stdInThread = new Thread("Stdin " + getSshTarget()) {
+ @Override
+ public void run() {
+ OutputStream out = null;
+ try {
+ out = channel.getOutputStream();
+ IOUtils.copy(stdIn.getInputStream(), out);
+ } catch (IOException e) {
+ throw new SlcException("Cannot write stdin on "
+ + getSshTarget(), e);
+ } finally {
+ IOUtils.closeQuietly(out);
}
}
+ };
+ stdInThread.start();
+ } else if (streamHandler != null) {
+ try {
+ streamHandler.setProcessInputStream(channel.getOutputStream());
+ } catch (IOException e) {
+ throw new SlcException("Cannot write stdin on "
+ + getSshTarget(), e);
}
- } catch (IOException e) {
- if (log.isDebugEnabled())
- log.error("Cannot read stdout from " + getSshTarget(), e);
- } finally {
- IOUtils.closeQuietly(stdOut);
}
}
protected void checkExitStatus(Channel channel) {
if (channel.isClosed()) {
- int exitStatus = channel.getExitStatus();
- if (exitStatus == 0) {
+ lastExitStatus = channel.getExitStatus();
+ if (lastExitStatus == 0) {
if (log.isTraceEnabled())
- log.trace("Remote execution exit status: " + exitStatus);
+ log.trace("Remote execution exit status: " + lastExitStatus);
} else {
String msg = "Remote execution failed with " + " exit status: "
- + exitStatus;
+ + lastExitStatus;
if (failOnBadExitStatus)
throw new SlcException(msg);
else
}
+ protected OutputStream createOutputStream(Resource target) {
+ FileOutputStream out = null;
+ try {
+
+ final File file;
+ if (executionResources != null)
+ file = new File(executionResources.getAsOsPath(target, true));
+ else
+ file = target.getFile();
+ out = new FileOutputStream(file, false);
+ } catch (IOException e) {
+ log.error("Cannot get file for " + target, e);
+ IOUtils.closeQuietly(out);
+ }
+ return out;
+ }
+
+ public Integer getLastExitStatus() {
+ return lastExitStatus;
+ }
+
+ public void setStreamHandler(ExecuteStreamHandler executeStreamHandler) {
+ this.streamHandler = executeStreamHandler;
+ }
+
public void setCommand(String command) {
this.command = command;
}
this.stdIn = stdIn;
}
+ public void setStdOut(Resource stdOut) {
+ this.stdOut = stdOut;
+ }
+
+ public void setExecutionResources(ExecutionResources executionResources) {
+ this.executionResources = executionResources;
+ }
+
+ public void setUser(String user) {
+ this.user = user;
+ }
+
}