Compare commits

...

2 Commits

Author SHA1 Message Date
Arnaud Roques 91e87b9691 refactor: remove dead code 2024-04-14 11:29:32 +02:00
Arnaud Roques 171a35971b refactor: enhance external process handling using ProcessBuilder 2024-04-14 10:50:33 +02:00
6 changed files with 99 additions and 279 deletions

View File

@ -1,4 +1,4 @@
# Warning, "version" should be the same in gradle.properties and Version.java # Warning, "version" should be the same in gradle.properties and Version.java
# Any idea anyone how to magically synchronize those :-) ? # Any idea anyone how to magically synchronize those :-) ?
version = 1.2024.4 version = 1.2024.5beta1
org.gradle.workers.max = 3 org.gradle.workers.max = 3

View File

@ -113,7 +113,7 @@ public class OptionFlags {
systemExit = exit; systemExit = exit;
gui = false; gui = false;
quiet = false; quiet = false;
checkDotError = false; // checkDotError = false;
printFonts = false; printFonts = false;
// failOnError = false; // failOnError = false;
encodesprite = false; encodesprite = false;
@ -130,7 +130,7 @@ public class OptionFlags {
private boolean systemExit; private boolean systemExit;
private boolean gui; private boolean gui;
private boolean quiet; private boolean quiet;
private boolean checkDotError; // private boolean checkDotError;
private boolean printFonts; private boolean printFonts;
private boolean encodesprite; private boolean encodesprite;
private boolean dumpHtmlStats; private boolean dumpHtmlStats;
@ -195,12 +195,12 @@ public class OptionFlags {
this.quiet = quiet; this.quiet = quiet;
} }
public final boolean isCheckDotError() { // public final boolean isCheckDotError() {
return checkDotError; // return checkDotError;
} // }
public final void setCheckDotError(boolean checkDotError) { public final void setCheckDotError(boolean checkDotError) {
this.checkDotError = checkDotError; // this.checkDotError = checkDotError;
} }
private final AtomicBoolean logDataInitized = new AtomicBoolean(false); private final AtomicBoolean logDataInitized = new AtomicBoolean(false);

View File

@ -61,14 +61,13 @@ abstract class AbstractGraphviz implements Graphviz {
private static String findExecutableOnPath(String name) { private static String findExecutableOnPath(String name) {
final String path = System.getenv("PATH"); final String path = System.getenv("PATH");
if (path != null) { if (path != null)
for (String dirname : path.split(SFile.pathSeparator)) { for (String dirname : path.split(SFile.pathSeparator)) {
final File file = new File(dirname, name); final File file = new File(dirname, name);
if (file.isFile() && file.canExecute()) { if (file.isFile() && file.canExecute())
return file.getAbsolutePath(); return file.getAbsolutePath();
}
} }
}
return null; return null;
} }
@ -84,12 +83,12 @@ abstract class AbstractGraphviz implements Graphviz {
final protected File searchDotExe() { final protected File searchDotExe() {
String getenv = GraphvizUtils.getenvGraphvizDot(); String getenv = GraphvizUtils.getenvGraphvizDot();
if (findExecutableOnPath() && getenv == null) { if (findExecutableOnPath() && getenv == null)
getenv = findExecutableOnPath(getExeName()); getenv = findExecutableOnPath(getExeName());
}
if (getenv == null) { if (getenv == null)
return specificDotExe(); return specificDotExe();
}
return new File(getenv); return new File(getenv);
} }
@ -100,11 +99,9 @@ abstract class AbstractGraphviz implements Graphviz {
final public ProcessState createFile3(OutputStream os) { final public ProcessState createFile3(OutputStream os) {
Objects.requireNonNull(dotString); Objects.requireNonNull(dotString);
if (getExeState() != ExeState.OK) { if (getExeState() != ExeState.OK)
// createPngNoGraphviz(os, new
// FileFormatOption(FileFormat.valueOf(type[0].goUpperCase())));
throw new IllegalStateException(); throw new IllegalStateException();
}
final String cmd[] = getCommandLine(); final String cmd[] = getCommandLine();
ProcessRunner p = null; ProcessRunner p = null;
ProcessState state = null; ProcessState state = null;
@ -113,9 +110,6 @@ abstract class AbstractGraphviz implements Graphviz {
Log.info("DotString size: " + dotString.length()); Log.info("DotString size: " + dotString.length());
p = new ProcessRunner(cmd); p = new ProcessRunner(cmd);
state = p.run(dotString.getBytes(), os); state = p.run(dotString.getBytes(), os);
// if (state == ProcessState.TERMINATED_OK) {
// result = true;
// }
Log.info("Ending process ok"); Log.info("Ending process ok");
} catch (Throwable e) { } catch (Throwable e) {
Logme.error(e); Logme.error(e);
@ -127,18 +121,17 @@ abstract class AbstractGraphviz implements Graphviz {
} finally { } finally {
Log.info("Ending Graphviz process"); Log.info("Ending Graphviz process");
} }
if (OptionFlags.getInstance().isCheckDotError() && p != null && p.getError().length() > 0) { // if (OptionFlags.getInstance().isCheckDotError() && p != null && p.getError().length() > 0) {
Log.error("GraphViz error stream : " + p.getError()); // Log.error("GraphViz error stream : " + p.getError());
if (OptionFlags.getInstance().isCheckDotError()) { // if (OptionFlags.getInstance().isCheckDotError())
throw new IllegalStateException("Dot error " + p.getError()); // throw new IllegalStateException("Dot error " + p.getError());
} //
} // }
if (OptionFlags.getInstance().isCheckDotError() && p != null && p.getOut().length() > 0) { // if (OptionFlags.getInstance().isCheckDotError() && p != null && p.getOut().length() > 0) {
Log.error("GraphViz out stream : " + p.getOut()); // Log.error("GraphViz out stream : " + p.getOut());
if (OptionFlags.getInstance().isCheckDotError()) { // if (OptionFlags.getInstance().isCheckDotError())
throw new IllegalStateException("Dot out " + p.getOut()); // throw new IllegalStateException("Dot out " + p.getOut());
} // }
}
return state; return state;
} }
@ -154,17 +147,17 @@ abstract class AbstractGraphviz implements Graphviz {
private String executeCmd(final String cmd[]) { private String executeCmd(final String cmd[]) {
final ProcessRunner p = new ProcessRunner(cmd); final ProcessRunner p = new ProcessRunner(cmd);
final ProcessState state = p.run(null, null); final ProcessState state = p.run(null, null);
if (state.differs(ProcessState.TERMINATED_OK())) { if (state.differs(ProcessState.TERMINATED_OK()))
return "?"; return "?";
}
final StringBuilder sb = new StringBuilder(); final StringBuilder sb = new StringBuilder();
if (StringUtils.isNotEmpty(p.getOut())) { if (StringUtils.isNotEmpty(p.getOut()))
sb.append(p.getOut()); sb.append(p.getOut());
}
if (StringUtils.isNotEmpty(p.getError())) { if (StringUtils.isNotEmpty(p.getError())) {
if (sb.length() > 0) { if (sb.length() > 0)
sb.append(' '); sb.append(' ');
}
sb.append(p.getError()); sb.append(p.getError());
} }
return StringUtils.trin(sb.toString().replace('\n', ' ')); return StringUtils.trin(sb.toString().replace('\n', ' '));
@ -177,16 +170,16 @@ abstract class AbstractGraphviz implements Graphviz {
result[1] = "-n"; result[1] = "-n";
result[2] = "10"; result[2] = "10";
result[3] = getDotExe().getAbsolutePath(); result[3] = getDotExe().getAbsolutePath();
for (int i = 0; i < type.length; i++) { for (int i = 0; i < type.length; i++)
result[i + 4] = "-T" + type[i]; result[i + 4] = "-T" + type[i];
}
return result; return result;
} }
final String[] result = new String[type.length + 1]; final String[] result = new String[type.length + 1];
result[0] = getDotExe().getAbsolutePath(); result[0] = getDotExe().getAbsolutePath();
for (int i = 0; i < type.length; i++) { for (int i = 0; i < type.length; i++)
result[i + 1] = "-T" + type[i]; result[i + 1] = "-T" + type[i];
}
return result; return result;
} }

View File

@ -35,15 +35,12 @@
*/ */
package net.sourceforge.plantuml.dot; package net.sourceforge.plantuml.dot;
import java.io.IOException; import java.io.ByteArrayOutputStream;
import java.io.InputStream; import java.io.InputStream;
import java.io.OutputStream; import java.io.OutputStream;
import java.util.concurrent.locks.Lock; import java.util.concurrent.TimeUnit;
import java.util.concurrent.locks.ReentrantLock;
import net.sourceforge.plantuml.OptionFlags; import net.sourceforge.plantuml.OptionFlags;
import net.sourceforge.plantuml.api.MyRunnable;
import net.sourceforge.plantuml.api.TimeoutExecutor;
import net.sourceforge.plantuml.log.Logme; import net.sourceforge.plantuml.log.Logme;
import net.sourceforge.plantuml.security.SFile; import net.sourceforge.plantuml.security.SFile;
@ -51,209 +48,77 @@ public class ProcessRunner {
// ::remove file when __CORE__ // ::remove file when __CORE__
private final String[] cmd; private final String[] cmd;
private String error; private String error;
private String out; private String out;
private volatile ProcessState state = ProcessState.INIT();
private final Lock changeState = new ReentrantLock();
public ProcessRunner(String[] cmd) { public ProcessRunner(String[] cmd) {
this.cmd = cmd; this.cmd = cmd;
} }
public ProcessState run(byte in[], OutputStream redirection) { public ProcessState run(byte[] in, OutputStream redirection) {
return run(in, redirection, null); return run(in, redirection, null);
} }
public ProcessState run(byte in[], OutputStream redirection, SFile dir) { public ProcessState run(byte[] in, OutputStream redirection, SFile dir) {
if (this.state.differs(ProcessState.INIT())) { Process process = null;
throw new IllegalStateException();
}
this.state = ProcessState.RUNNING();
final MainThread mainThread = new MainThread(cmd, dir, redirection, in);
try { try {
// http://steveliles.github.io/invoking_processes_from_java.html final ProcessBuilder builder = new ProcessBuilder(cmd);
if (dir != null)
builder.directory(dir.conv());
builder.redirectErrorStream(true);
process = builder.start();
// Handling input to the process
if (in != null)
try (OutputStream os = process.getOutputStream()) {
os.write(in);
}
final ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
try (InputStream is = process.getInputStream()) {
final byte[] buffer = new byte[1024];
int length;
while ((length = is.read(buffer)) != -1) {
outputStream.write(buffer, 0, length);
if (redirection != null)
redirection.write(buffer, 0, length);
}
}
// Wait for process to terminate
final long timeoutMs = OptionFlags.getInstance().getTimeoutMs(); final long timeoutMs = OptionFlags.getInstance().getTimeoutMs();
final boolean done = new TimeoutExecutor(timeoutMs).executeNow(mainThread); final boolean finished = process.waitFor(timeoutMs, TimeUnit.MILLISECONDS);
outputStream.close();
if (finished) {
this.out = new String(outputStream.toByteArray(), "UTF-8");
return ProcessState.TERMINATED_OK();
}
return ProcessState.TIMEOUT();
} catch (Throwable e) {
Logme.error(e);
this.error = e.toString();
return ProcessState.EXCEPTION(e);
} finally { } finally {
changeState.lock(); if (process != null && out == null && process.isAlive()) {
try { // Process did not finish in time, kill it
if (state.equals(ProcessState.RUNNING())) {
state = ProcessState.TIMEOUT();
// mainThread.cancel();
}
} finally {
changeState.unlock();
}
}
if (state.equals(ProcessState.TERMINATED_OK())) {
assert mainThread != null;
this.error = mainThread.getError();
this.out = mainThread.getOut();
}
return state;
}
class MainThread implements MyRunnable {
private final String[] cmd;
private final SFile dir;
private final OutputStream redirection;
private final byte[] in;
private volatile Process process;
private volatile ThreadStream errorStream;
private volatile ThreadStream outStream;
public MainThread(String[] cmd, SFile dir, OutputStream redirection, byte[] in) {
this.cmd = cmd;
this.dir = dir;
this.redirection = redirection;
this.in = in;
}
public String getOut() {
return outStream.getString();
}
public String getError() {
return errorStream.getString();
}
public void runJob() throws InterruptedException {
try {
startThreads();
if (state.equals(ProcessState.RUNNING())) {
final int result = joinInternal();
}
} finally {
changeState.lock();
try {
if (state.equals(ProcessState.RUNNING())) {
state = ProcessState.TERMINATED_OK();
}
} finally {
changeState.unlock();
}
if (process != null) {
process.destroy();
close(process.getErrorStream());
close(process.getOutputStream());
close(process.getInputStream());
}
}
}
public void cancelJob() {
// The changeState lock is ok
// assert changeState.tryLock();
// assert state == ProcessState.TIMEOUT;
if (process != null) {
errorStream.cancel();
outStream.cancel();
process.destroy(); process.destroy();
// interrupt(); // Not really sure that we should overwrite "this.error" here
close(process.getErrorStream()); this.error = "Timeout - kill";
close(process.getOutputStream());
close(process.getInputStream());
}
}
private void startThreads() {
try {
process = Runtime.getRuntime().exec(cmd, null, dir == null ? null : dir.conv());
} catch (IOException e) {
Logme.error(e);
changeState.lock();
try { try {
state = ProcessState.IO_EXCEPTION1(e); if (process.waitFor(500, TimeUnit.MILLISECONDS) == false) {
} finally { process.destroyForcibly();
changeState.unlock(); this.error = "Timeout - kill force";
}
} catch (InterruptedException e) {
// Nothing we can really do
e.printStackTrace();
} }
Logme.error(e);
return;
} }
errorStream = new ThreadStream(process.getErrorStream(), null);
outStream = new ThreadStream(process.getInputStream(), redirection);
errorStream.start();
outStream.start();
if (in != null) {
final OutputStream os = process.getOutputStream();
try {
try {
os.write(in);
} finally {
os.close();
}
} catch (IOException e) {
changeState.lock();
try {
state = ProcessState.IO_EXCEPTION2(e);
} finally {
changeState.unlock();
}
Logme.error(e);
}
}
}
public int joinInternal() throws InterruptedException {
errorStream.join();
outStream.join();
final int result = process.waitFor();
return result;
}
}
class ThreadStream extends Thread {
private volatile InputStream streamToRead;
private volatile OutputStream redirection;
private volatile StringBuffer sb = new StringBuffer();
ThreadStream(InputStream streamToRead, OutputStream redirection) {
this.streamToRead = streamToRead;
this.redirection = redirection;
}
public String getString() {
if (sb == null) {
return "";
}
return sb.toString();
}
public void cancel() {
assert state.equals(ProcessState.TIMEOUT()) || state.equals(ProcessState.RUNNING()) : state;
this.interrupt();
sb = null;
streamToRead = null;
redirection = null;
// Because of this, some NPE may occurs in run() method, but we do not care
}
@Override
public void run() {
int read = 0;
try {
while ((read = streamToRead.read()) != -1) {
if (state.equals(ProcessState.TIMEOUT())) {
return;
}
if (redirection == null) {
sb.append((char) read);
} else {
redirection.write(read);
}
}
} catch (Throwable e) {
System.err.println("ProcessRunnerA " + e);
Logme.error(e);
sb.append('\n');
sb.append(e.toString());
}
} }
} }
@ -265,24 +130,4 @@ public class ProcessRunner {
return out; return out;
} }
private void close(InputStream is) {
try {
if (is != null) {
is.close();
}
} catch (IOException e) {
Logme.error(e);
}
}
private void close(OutputStream os) {
try {
if (os != null) {
os.close();
}
} catch (IOException e) {
Logme.error(e);
}
}
} }

View File

@ -35,42 +35,28 @@
*/ */
package net.sourceforge.plantuml.dot; package net.sourceforge.plantuml.dot;
import java.io.IOException;
public class ProcessState { public class ProcessState {
// ::remove file when __CORE__ // ::remove file when __CORE__
private final String name; private final String name;
private final IOException cause; private final Throwable cause;
private ProcessState(String name, IOException cause) { private ProcessState(String name, Throwable cause) {
this.name = name; this.name = name;
this.cause = cause; this.cause = cause;
} }
@Override @Override
public String toString() { public String toString() {
if (cause == null) { if (cause == null)
return name; return name;
}
return name + " " + cause.toString(); return name + " " + cause.toString();
} }
private final static ProcessState INIT = new ProcessState("INIT", null);
private final static ProcessState RUNNING = new ProcessState("RUNNING", null);
private final static ProcessState TERMINATED_OK = new ProcessState("TERMINATED_OK", null); private final static ProcessState TERMINATED_OK = new ProcessState("TERMINATED_OK", null);
private final static ProcessState TIMEOUT = new ProcessState("TIMEOUT", null); private final static ProcessState TIMEOUT = new ProcessState("TIMEOUT", null);
// INIT, RUNNING, TERMINATED_OK, TIMEOUT, IO_EXCEPTION1, IO_EXCEPTION2;
public static ProcessState INIT() {
return INIT;
}
public static ProcessState RUNNING() {
return RUNNING;
}
public static ProcessState TERMINATED_OK() { public static ProcessState TERMINATED_OK() {
return TERMINATED_OK; return TERMINATED_OK;
} }
@ -79,12 +65,8 @@ public class ProcessState {
return TIMEOUT; return TIMEOUT;
} }
public static ProcessState IO_EXCEPTION1(IOException e) { public static ProcessState EXCEPTION(Throwable e) {
return new ProcessState("IO_EXCEPTION1", e); return new ProcessState("EXCEPTION", e);
}
public static ProcessState IO_EXCEPTION2(IOException e) {
return new ProcessState("IO_EXCEPTION2", e);
} }
public boolean differs(ProcessState other) { public boolean differs(ProcessState other) {

View File

@ -46,7 +46,7 @@ public class Version {
// Warning, "version" should be the same in gradle.properties and Version.java // Warning, "version" should be the same in gradle.properties and Version.java
// Any idea anyone how to magically synchronize those :-) ? // Any idea anyone how to magically synchronize those :-) ?
private static final String version = "1.2024.4"; private static final String version = "1.2024.5beta1";
public static String versionString() { public static String versionString() {
return version; return version;