net.sourceforge.plantuml.dot.AbstractGraphviz Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of plantuml-epl Show documentation
Show all versions of plantuml-epl Show documentation
PlantUML is a component that allows to quickly write diagrams from text.
// THIS FILE HAS BEEN GENERATED BY A PREPROCESSOR.
/* +=======================================================================
* |
* | PlantUML : a free UML diagram generator
* |
* +=======================================================================
*
* (C) Copyright 2009-2024, Arnaud Roques
*
* Project Info: https://plantuml.com
*
* If you like this project or if you find it useful, you can support us at:
*
* https://plantuml.com/patreon (only 1$ per month!)
* https://plantuml.com/liberapay (only 1€ per month!)
* https://plantuml.com/paypal
*
*
* PlantUML is free software; you can redistribute it and/or modify it
* under the terms of the Eclipse Public License.
*
* THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE PUBLIC
* LICENSE ("AGREEMENT"). [Eclipse Public License - v 1.0]
*
* ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES
* RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
*
* You may obtain a copy of the License at
*
* http://www.eclipse.org/legal/epl-v10.html
*
* 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.
*
* PlantUML can occasionally display sponsored or advertising messages. Those
* messages are usually generated on welcome or error images and never on
* functional diagrams.
* See https://plantuml.com/professional if you want to remove them
*
* Images (whatever their format : PNG, SVG, EPS...) generated by running PlantUML
* are owned by the author of their corresponding sources code (that is, their
* textual description in PlantUML language). Those images are not covered by
* this EPL license.
*
* The generated images can then be used without any reference to the EPL license.
* It is not even necessary to stipulate that they have been generated with PlantUML,
* although this will be appreciated by the PlantUML team.
*
* There is an exception : if the textual description in PlantUML language is also covered
* by any license, then the generated images are logically covered
* by the very same license.
*
* This is the IGY distribution (Install GraphViz by Yourself).
* You have to install GraphViz and to setup the GRAPHVIZ_DOT environment variable
* (see https://plantuml.com/graphviz-dot )
*
* Icons provided by OpenIconic : https://useiconic.com/open
* Archimate sprites provided by Archi : http://www.archimatetool.com
* Stdlib AWS provided by https://github.com/milo-minderbinder/AWS-PlantUML
* Stdlib Icons provided https://github.com/tupadr3/plantuml-icon-font-sprites
* ASCIIMathML (c) Peter Jipsen http://www.chapman.edu/~jipsen
* ASCIIMathML (c) David Lippman http://www.pierce.ctc.edu/dlippman
* CafeUndZopfli ported by Eugene Klyuchnikov https://github.com/eustas/CafeUndZopfli
* Brotli (c) by the Brotli Authors https://github.com/google/brotli
* Themes (c) by Brett Schwarz https://github.com/bschwarz/puml-themes
* Twemoji (c) by Twitter at https://twemoji.twitter.com/
*
*/
package net.sourceforge.plantuml.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.OptionFlags;
import net.sourceforge.plantuml.StringUtils;
import net.sourceforge.plantuml.log.Logme;
import net.sourceforge.plantuml.security.SFile;
import net.sourceforge.plantuml.style.ISkinParam;
import net.sourceforge.plantuml.utils.Log;
abstract class AbstractGraphviz implements Graphviz {
// ::remove file when __CORE__
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)
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);
Log.info("Ending process ok");
} catch (Throwable e) {
Logme.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 getType() {
return Arrays.asList(type);
}
}