net.sourceforge.plantuml.dot.GraphvizUtils Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of plantuml-asl Show documentation
Show all versions of plantuml-asl Show documentation
PlantUML is a component that allows to quickly write diagrams from text.
The newest version!
// 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 Apache Software License.
*
* 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.
*
* 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 APACHE license.
*
* The generated images can then be used without any reference to the APACHE 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.ByteArrayOutputStream;
import java.io.File;
import java.io.IOException;
import java.util.List;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import net.sourceforge.plantuml.StringUtils;
import net.sourceforge.plantuml.log.Logme;
import net.sourceforge.plantuml.security.SFile;
import net.sourceforge.plantuml.security.SecurityProfile;
import net.sourceforge.plantuml.security.SecurityUtils;
import net.sourceforge.plantuml.style.ISkinParam;
import net.sourceforge.plantuml.utils.Log;
import net.sourceforge.plantuml.vizjs.GraphvizJs;
import net.sourceforge.plantuml.vizjs.VizJsEngine;
public class GraphvizUtils {
// ::remove file when __CORE__
public static final String VIZJS = "vizjs";
private static int DOT_VERSION_LIMIT = 226;
private static boolean isWindows() {
return SFile.separatorChar == '\\';
}
private static String dotExecutable;
public static final String getDotExecutableForTest() {
return dotExecutable;
}
public static final void setDotExecutable(String value) {
dotExecutable = value == null ? null : value.trim();
}
public static Graphviz createForSystemDot(ISkinParam skinParam, String dotString, String... type) {
if (useVizJs(skinParam)) {
Log.info("Using " + VIZJS);
return new GraphvizJs(dotString);
}
final AbstractGraphviz result;
if (isWindows())
result = new GraphvizWindowsOld(skinParam, dotString, type);
else
result = new GraphvizLinux(skinParam, dotString, type);
if (result.getExeState() != ExeState.OK && VizJsEngine.isOk()) {
Log.info("Error with file " + result.getDotExe() + ": " + result.getExeState().getTextMessage());
Log.info("Using " + VIZJS);
return new GraphvizJs(dotString);
}
return result;
}
public static Graphviz create(ISkinParam skinParam, String dotString, String... type) {
if (useVizJs(skinParam)) {
Log.info("Using " + VIZJS);
return new GraphvizJs(dotString);
}
final AbstractGraphviz result;
if (isWindows())
result = new GraphvizWindowsLite(skinParam, dotString, type);
else
result = new GraphvizLinux(skinParam, dotString, type);
if (result.getExeState() != ExeState.OK && VizJsEngine.isOk()) {
Log.info("Error with file " + result.getDotExe() + ": " + result.getExeState().getTextMessage());
Log.info("Using " + VIZJS);
return new GraphvizJs(dotString);
}
return result;
}
private static boolean useVizJs(ISkinParam skinParam) {
if (skinParam != null && skinParam.isUseVizJs() && VizJsEngine.isOk())
return true;
if (VIZJS.equalsIgnoreCase(getenvGraphvizDot()) && VizJsEngine.isOk())
return true;
return false;
}
static public File getDotExe() {
return create(null, "png").getDotExe();
}
public static String getenvGraphvizDot() {
if (StringUtils.isNotEmpty(dotExecutable))
return StringUtils.eventuallyRemoveStartingAndEndingDoubleQuote(dotExecutable);
final String env = System.getProperty("GRAPHVIZ_DOT");
if (StringUtils.isNotEmpty(env))
return StringUtils.eventuallyRemoveStartingAndEndingDoubleQuote(env);
final String getenv = System.getenv("GRAPHVIZ_DOT");
if (StringUtils.isNotEmpty(getenv))
return StringUtils.eventuallyRemoveStartingAndEndingDoubleQuote(getenv);
return null;
}
private static final ThreadLocal limitSize = new ThreadLocal<>();
public static void removeLocalLimitSize() {
limitSize.remove();
}
public static void setLocalImageLimit(int value) {
limitSize.set(value);
}
public static int getenvImageLimit() {
final Integer local = limitSize.get();
if (local != null)
return local;
final String env = SecurityUtils.getenv("PLANTUML_LIMIT_SIZE");
if (StringUtils.isNotEmpty(env) && env.matches("\\d+"))
return Integer.parseInt(env);
return 4096;
}
public static String getenvDefaultConfigFilename() {
return SecurityUtils.getenv("PLANTUML_DEFAULT_CONFIG_FILENAME");
}
public static String getenvLogData() {
return SecurityUtils.getenv("PLANTUML_LOGDATA");
}
private static String dotVersion = null;
public static String dotVersion() throws IOException, InterruptedException {
if (dotVersion == null) {
final File dotExe = GraphvizUtils.getDotExe();
final ExeState exeState = ExeState.checkFile(dotExe);
if (exeState == ExeState.OK)
dotVersion = create(null, "png").dotVersion();
else
dotVersion = "Error:" + exeState.getTextMessage(dotExe);
}
return dotVersion;
}
public static boolean graphviz244onWindows() {
try {
return create(null, "png").graphviz244onWindows();
} catch (Exception e) {
Logme.error(e);
return false;
}
}
public static int retrieveVersion(String s) {
if (s == null)
return -1;
final Pattern p = Pattern.compile("\\s(\\d+)\\.(\\d\\d?)\\D");
final Matcher m = p.matcher(s);
if (m.find() == false)
return -1;
return 100 * Integer.parseInt(m.group(1)) + Integer.parseInt(m.group(2));
}
public static int getDotVersion() throws IOException, InterruptedException {
return retrieveVersion(dotVersion());
}
static public int addDotStatus(List result, boolean withRichText) {
String red = "";
String bold = "";
if (withRichText) {
red = "";
bold = "";
}
int error = 0;
if (useVizJs(null)) {
result.add("VizJs library is used!");
try {
final String err = getTestCreateSimpleFile();
if (err == null)
result.add(bold + "Installation seems OK. File generation OK");
else
result.add(red + err);
} catch (Exception e) {
result.add(red + e.toString());
Logme.error(e);
error = -1;
}
return error;
}
final File dotExe = GraphvizUtils.getDotExe();
if (SecurityUtils.getSecurityProfile() == SecurityProfile.UNSECURE) {
final String ent = GraphvizUtils.getenvGraphvizDot();
if (ent == null)
result.add("The environment variable GRAPHVIZ_DOT has not been set");
else
result.add("The environment variable GRAPHVIZ_DOT has been set to " + ent);
result.add("Dot executable is " + dotExe);
}
final ExeState exeState = ExeState.checkFile(dotExe);
if (exeState == ExeState.OK) {
try {
final String version = GraphvizUtils.dotVersion();
result.add("Dot version: " + version);
final int v = GraphvizUtils.getDotVersion();
if (v == -1) {
result.add("Warning : cannot determine dot version");
error = -2;
} else if (v < DOT_VERSION_LIMIT) {
result.add(bold + "Warning : Your dot installation seems old");
result.add(bold + "Some diagrams may have issues");
error = -3;
} else {
final String err = getTestCreateSimpleFile();
if (err == null) {
result.add(bold + "Installation seems OK. File generation OK");
} else {
result.add(red + err);
error = -4;
}
}
} catch (Exception e) {
result.add(red + e.toString());
Logme.error(e);
error = -5;
}
} else {
result.add(red + "Error: " + exeState.getTextMessage());
result.add("Error: only sequence diagrams will be generated");
error = -6;
}
return error;
}
static String getTestCreateSimpleFile() throws IOException {
final Graphviz graphviz2 = GraphvizUtils.create(null, "digraph foo { test; }", "svg");
final ByteArrayOutputStream baos = new ByteArrayOutputStream();
final ProcessState state = graphviz2.createFile3(baos);
if (state.differs(ProcessState.TERMINATED_OK()))
return "Error: timeout " + state;
final byte data[] = baos.toByteArray();
if (data.length == 0)
return "Error: dot generates empty file. Check you dot installation.";
final String s = new String(data);
if (s.indexOf("