1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
|
/* ========================================================================
* PlantUML : a free UML diagram generator
* ========================================================================
*
* (C) Copyright 2009-2017, Arnaud Roques
*
* Project Info: http://plantuml.com
*
* This file is part of PlantUML.
*
* Licensed under The MIT License (Massachusetts Institute of Technology License)
*
* See http://opensource.org/licenses/MIT
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included
* in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
* IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*
*
* Original Author: Arnaud Roques
*/
package net.sourceforge.plantuml.cucadiagram.dot;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import net.sourceforge.plantuml.ISkinParam;
import net.sourceforge.plantuml.StringUtils;
public class GraphvizUtils {
private static int DOT_VERSION_LIMIT = 226;
private static boolean isWindows() {
return File.separatorChar == '\\';
}
private static String dotExecutable;
public static final String getDotExecutableForTest() {
return dotExecutable;
}
public static final void setDotExecutable(String value) {
dotExecutable = value;
}
public static Graphviz create(ISkinParam skinParam, String dotString, String... type) {
final AbstractGraphviz result;
if (isWindows()) {
result = new GraphvizWindows(skinParam, dotString, type);
} else {
result = new GraphvizLinux(skinParam, dotString, type);
}
// if (OptionFlags.GRAPHVIZCACHE) {
// return new GraphvizCached(result);
// }
return result;
}
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;
}
public static int getenvImageLimit() {
final String env = System.getProperty("PLANTUML_LIMIT_SIZE");
if (StringUtils.isNotEmpty(env) && env.matches("\\d+")) {
return Integer.parseInt(env);
}
final String getenv = System.getenv("PLANTUML_LIMIT_SIZE");
if (StringUtils.isNotEmpty(getenv) && getenv.matches("\\d+")) {
return Integer.parseInt(getenv);
}
return 4096;
}
public static String getenvLogData() {
final String env = System.getProperty("PLANTUML_LOGDATA");
if (StringUtils.isNotEmpty(env)) {
return env;
}
return System.getenv("PLANTUML_LOGDATA");
}
private static String dotVersion = null;
public static String dotVersion() throws IOException, InterruptedException {
if (dotVersion == null) {
if (GraphvizUtils.getDotExe() == null) {
dotVersion = "Error: Dot not installed";
} else if (GraphvizUtils.getDotExe().exists() == false) {
dotVersion = "Error: " + GraphvizUtils.getDotExe().getAbsolutePath() + " does not exist";
} else if (GraphvizUtils.getDotExe().isFile() == false) {
dotVersion = "Error: " + GraphvizUtils.getDotExe().getAbsolutePath() + " is not a file";
} else if (GraphvizUtils.getDotExe().canRead() == false) {
dotVersion = "Error: " + GraphvizUtils.getDotExe().getAbsolutePath() + " cannot be read";
} else {
dotVersion = create(null, "png").dotVersion();
}
}
return dotVersion;
}
public static int retrieveVersion(String s) {
if (s == null) {
return -1;
}
final Pattern p = Pattern.compile("\\s([12].\\d\\d)\\D");
final Matcher m = p.matcher(s);
if (m.find() == false) {
return -1;
}
return Integer.parseInt(m.group(1).replaceAll("\\.", ""));
}
public static int getDotVersion() throws IOException, InterruptedException {
return retrieveVersion(dotVersion());
}
static public List<String> getTestDotStrings(boolean withRichText) {
String red = "";
String bold = "";
if (withRichText) {
red = "<b><color:red>";
bold = "<b>";
}
final List<String> result = new ArrayList<String>();
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);
}
final File dotExe = GraphvizUtils.getDotExe();
result.add("Dot executable is " + dotExe);
boolean ok = true;
if (dotExe == null) {
result.add(red + "Error: No dot executable found");
ok = false;
} else if (dotExe.exists() == false) {
result.add(red + "Error: file does not exist");
ok = false;
} else if (dotExe.isFile() == false) {
result.add(red + "Error: not a valid file");
ok = false;
} else if (dotExe.canRead() == false) {
result.add(red + "Error: cannot be read");
ok = false;
}
if (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");
} else if (v < DOT_VERSION_LIMIT) {
result.add(bold + "Warning : Your dot installation seems old");
result.add(bold + "Some diagrams may have issues");
} else {
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());
e.printStackTrace();
}
} else {
result.add("Error: only sequence diagrams will be generated");
}
return Collections.unmodifiableList(result);
}
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("<svg") == -1) {
return "Error: dot generates unreadable SVG file. Check you dot installation.";
}
return null;
}
}
|
