mirror of https://github.com/octoleo/plantuml.git
209 lines
5.9 KiB
Java
209 lines
5.9 KiB
Java
/* ========================================================================
|
|
* PlantUML : a free UML diagram generator
|
|
* ========================================================================
|
|
*
|
|
* (C) Copyright 2009-2023, Arnaud Roques
|
|
*
|
|
* Project Info: http://plantuml.com
|
|
*
|
|
* If you like this project or if you find it useful, you can support us at:
|
|
*
|
|
* http://plantuml.com/patreon (only 1$ per month!)
|
|
* http://plantuml.com/paypal
|
|
*
|
|
* This file is part of PlantUML.
|
|
*
|
|
* PlantUML is free software; you can redistribute it and/or modify it
|
|
* under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* PlantUML 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 General Public
|
|
* License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public
|
|
* License along with this library; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
|
|
* USA.
|
|
*
|
|
*
|
|
* Original Author: Arnaud Roques
|
|
*
|
|
*
|
|
*/
|
|
package net.sourceforge.plantuml.cucadiagram.dot;
|
|
|
|
import java.io.File;
|
|
import java.io.OutputStream;
|
|
import java.util.Arrays;
|
|
import java.util.List;
|
|
import java.util.Objects;
|
|
|
|
import net.sourceforge.plantuml.ISkinParam;
|
|
import net.sourceforge.plantuml.Log;
|
|
import net.sourceforge.plantuml.OptionFlags;
|
|
import net.sourceforge.plantuml.StringUtils;
|
|
import net.sourceforge.plantuml.log.Logger;
|
|
import net.sourceforge.plantuml.security.SFile;
|
|
|
|
abstract class AbstractGraphviz implements Graphviz {
|
|
|
|
private final File dotExe;
|
|
private final String dotString;
|
|
private final String[] type;
|
|
|
|
static boolean isWindows() {
|
|
return File.separatorChar == '\\';
|
|
}
|
|
|
|
private static String findExecutableOnPath(String name) {
|
|
final String path = System.getenv("PATH");
|
|
if (path != null) {
|
|
for (String dirname : path.split(SFile.pathSeparator)) {
|
|
final File file = new File(dirname, name);
|
|
if (file.isFile() && file.canExecute()) {
|
|
return file.getAbsolutePath();
|
|
}
|
|
}
|
|
}
|
|
return null;
|
|
}
|
|
|
|
AbstractGraphviz(ISkinParam skinParam, String dotString, String... type) {
|
|
this.dotExe = searchDotExe();
|
|
this.dotString = dotString;
|
|
this.type = Objects.requireNonNull(type);
|
|
}
|
|
|
|
protected boolean findExecutableOnPath() {
|
|
return true;
|
|
}
|
|
|
|
final protected File searchDotExe() {
|
|
String getenv = GraphvizUtils.getenvGraphvizDot();
|
|
if (findExecutableOnPath() && getenv == null) {
|
|
getenv = findExecutableOnPath(getExeName());
|
|
}
|
|
if (getenv == null) {
|
|
return specificDotExe();
|
|
}
|
|
return new File(getenv);
|
|
}
|
|
|
|
abstract protected File specificDotExe();
|
|
|
|
abstract protected String getExeName();
|
|
|
|
final public ProcessState createFile3(OutputStream os) {
|
|
Objects.requireNonNull(dotString);
|
|
|
|
if (getExeState() != ExeState.OK) {
|
|
// createPngNoGraphviz(os, new
|
|
// FileFormatOption(FileFormat.valueOf(type[0].goUpperCase())));
|
|
throw new IllegalStateException();
|
|
}
|
|
final String cmd[] = getCommandLine();
|
|
ProcessRunner p = null;
|
|
ProcessState state = null;
|
|
try {
|
|
Log.info("Starting Graphviz process " + Arrays.asList(cmd));
|
|
Log.info("DotString size: " + dotString.length());
|
|
p = new ProcessRunner(cmd);
|
|
state = p.run(dotString.getBytes(), os);
|
|
// if (state == ProcessState.TERMINATED_OK) {
|
|
// result = true;
|
|
// }
|
|
Log.info("Ending process ok");
|
|
} catch (Throwable e) {
|
|
Logger.error(e);
|
|
Log.error("Error: " + e);
|
|
Log.error("The command was " + cmd);
|
|
Log.error("");
|
|
Log.error("Try java -jar plantuml.jar -testdot to figure out the issue");
|
|
Log.error("");
|
|
} finally {
|
|
Log.info("Ending Graphviz process");
|
|
}
|
|
if (OptionFlags.getInstance().isCheckDotError() && p != null && p.getError().length() > 0) {
|
|
Log.error("GraphViz error stream : " + p.getError());
|
|
if (OptionFlags.getInstance().isCheckDotError()) {
|
|
throw new IllegalStateException("Dot error " + p.getError());
|
|
}
|
|
}
|
|
if (OptionFlags.getInstance().isCheckDotError() && p != null && p.getOut().length() > 0) {
|
|
Log.error("GraphViz out stream : " + p.getOut());
|
|
if (OptionFlags.getInstance().isCheckDotError()) {
|
|
throw new IllegalStateException("Dot out " + p.getOut());
|
|
}
|
|
}
|
|
return state;
|
|
}
|
|
|
|
final public ExeState getExeState() {
|
|
return ExeState.checkFile(dotExe);
|
|
}
|
|
|
|
final public String dotVersion() {
|
|
final String cmd[] = getCommandLineVersion();
|
|
return executeCmd(cmd);
|
|
}
|
|
|
|
private String executeCmd(final String cmd[]) {
|
|
final ProcessRunner p = new ProcessRunner(cmd);
|
|
final ProcessState state = p.run(null, null);
|
|
if (state.differs(ProcessState.TERMINATED_OK())) {
|
|
return "?";
|
|
}
|
|
final StringBuilder sb = new StringBuilder();
|
|
if (StringUtils.isNotEmpty(p.getOut())) {
|
|
sb.append(p.getOut());
|
|
}
|
|
if (StringUtils.isNotEmpty(p.getError())) {
|
|
if (sb.length() > 0) {
|
|
sb.append(' ');
|
|
}
|
|
sb.append(p.getError());
|
|
}
|
|
return StringUtils.trin(sb.toString().replace('\n', ' '));
|
|
}
|
|
|
|
final String[] getCommandLine() {
|
|
if (OptionFlags.ADD_NICE_FOR_DOT) {
|
|
final String[] result = new String[type.length + 1 + 3];
|
|
result[0] = "/bin/nice";
|
|
result[1] = "-n";
|
|
result[2] = "10";
|
|
result[3] = getDotExe().getAbsolutePath();
|
|
for (int i = 0; i < type.length; i++) {
|
|
result[i + 4] = "-T" + type[i];
|
|
}
|
|
return result;
|
|
}
|
|
final String[] result = new String[type.length + 1];
|
|
result[0] = getDotExe().getAbsolutePath();
|
|
for (int i = 0; i < type.length; i++) {
|
|
result[i + 1] = "-T" + type[i];
|
|
}
|
|
return result;
|
|
}
|
|
|
|
final String[] getCommandLineVersion() {
|
|
return new String[] { getDotExe().getAbsolutePath(), "-V" };
|
|
}
|
|
|
|
public final File getDotExe() {
|
|
return dotExe;
|
|
}
|
|
|
|
public final String getDotString() {
|
|
return dotString;
|
|
}
|
|
|
|
public final List<String> getType() {
|
|
return Arrays.asList(type);
|
|
}
|
|
|
|
}
|