net.sourceforge.plantuml.svek.GraphvizCrash Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of plantuml-mit Show documentation
Show all versions of plantuml-mit 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 MIT 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.
*
* 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 MIT license.
*
* The generated images can then be used without any reference to the MIT 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.svek;
import java.awt.Color;
import java.awt.image.BufferedImage;
import java.util.ArrayList;
import java.util.List;
import net.atmp.PixelImage;
import net.sourceforge.plantuml.OptionPrint;
import net.sourceforge.plantuml.StringUtils;
import net.sourceforge.plantuml.command.CommandExecutionResult;
import net.sourceforge.plantuml.dot.GraphvizUtils;
import net.sourceforge.plantuml.eggs.QuoteUtils;
import net.sourceforge.plantuml.flashcode.FlashCodeFactory;
import net.sourceforge.plantuml.fun.IconLoader;
import net.sourceforge.plantuml.klimt.AffineTransformType;
import net.sourceforge.plantuml.klimt.color.HColor;
import net.sourceforge.plantuml.klimt.color.HColors;
import net.sourceforge.plantuml.klimt.drawing.UGraphic;
import net.sourceforge.plantuml.klimt.font.StringBounder;
import net.sourceforge.plantuml.klimt.geom.GraphicPosition;
import net.sourceforge.plantuml.klimt.geom.HorizontalAlignment;
import net.sourceforge.plantuml.klimt.geom.XDimension2D;
import net.sourceforge.plantuml.klimt.shape.AbstractTextBlock;
import net.sourceforge.plantuml.klimt.shape.GraphicStrings;
import net.sourceforge.plantuml.klimt.shape.TextBlock;
import net.sourceforge.plantuml.klimt.shape.TextBlockUtils;
import net.sourceforge.plantuml.klimt.shape.UImage;
import net.sourceforge.plantuml.text.BackSlash;
import net.sourceforge.plantuml.version.PSystemVersion;
import net.sourceforge.plantuml.version.Version;
public class GraphvizCrash extends AbstractTextBlock implements IEntityImage {
private final TextBlock text1;
private final String text;
// ::comment when __CORE__
private final BufferedImage flashCode;
private final boolean graphviz244onWindows;
public GraphvizCrash(String text, boolean graphviz244onWindows, Throwable rootCause) {
this.text = text;
// ::comment when __CORE__
this.graphviz244onWindows = graphviz244onWindows;
this.flashCode = FlashCodeFactory.getFlashCodeUtils().exportFlashcode(text, Color.BLACK, Color.WHITE);
this.text1 = GraphicStrings.createBlackOnWhite(init(rootCause), IconLoader.getRandom(),
GraphicPosition.BACKGROUND_CORNER_TOP_RIGHT);
}
public static List anErrorHasOccured(Throwable exception, String text) {
final List strings = new ArrayList<>();
if (exception == null)
strings.add("An error has occured!");
else
strings.add("An error has occured : " + exception);
final String quote = StringUtils.rot(QuoteUtils.getSomeQuote());
strings.add("" + quote);
strings.add(" ");
strings.add("Diagram size: " + lines(text) + " lines / " + text.length() + " characters.");
strings.add(" ");
return strings;
}
private static int lines(String text) {
int result = 0;
for (int i = 0; i < text.length(); i++)
if (text.charAt(i) == BackSlash.CHAR_NEWLINE)
result++;
return result;
}
public static void checkOldVersionWarning(List strings) {
final long days = (System.currentTimeMillis() - Version.compileTime()) / 1000L / 3600 / 24;
if (days >= 90) {
strings.add(" ");
strings.add("This version of PlantUML is " + days + " days old, so you should");
strings.add("consider upgrading from https://plantuml.com/download");
}
}
public static void pleaseGoTo(List strings) {
strings.add(" ");
strings.add("Please go to https://plantuml.com/graphviz-dot to check your GraphViz version.");
strings.add(" ");
}
public static void youShouldSendThisDiagram(List strings) {
strings.add("You should send this diagram and this image to [email protected] or");
strings.add("post to https://plantuml.com/qa to solve this issue.");
strings.add("You can try to turn around this issue by simplifing your diagram.");
}
public static void thisMayBeCaused(final List strings) {
strings.add("This may be caused by :");
strings.add(" - a bug in PlantUML");
strings.add(" - a problem in GraphViz");
}
private List init(Throwable rootCause) {
final List strings = anErrorHasOccured(null, text);
strings.add("For some reason, dot/GraphViz has crashed.");
strings.add("");
strings.add("RootCause " + rootCause);
if (rootCause != null)
strings.addAll(CommandExecutionResult.getStackTrace(rootCause));
strings.add("");
strings.add("This has been generated with PlantUML (" + Version.versionString() + ").");
checkOldVersionWarning(strings);
strings.add(" ");
addProperties(strings);
strings.add(" ");
// ::comment when __CORE__
try {
final String dotVersion = GraphvizUtils.dotVersion();
strings.add("Default dot version: " + dotVersion);
} catch (Throwable e) {
strings.add("Cannot determine dot version: " + e.toString());
}
pleaseGoTo(strings);
youShouldSendThisDiagram(strings);
// ::comment when __CORE__
if (flashCode != null)
addDecodeHint(strings);
return strings;
}
private List getText2() {
final List strings = new ArrayList<>();
strings.add(" ");
strings.add("It looks like you are running GraphViz 2.44 under Windows.");
strings.add("If you have just installed GraphViz, you may have to execute");
strings.add("the post-install command dot -c like in the following example:");
return strings;
}
private List getText3() {
final List strings = new ArrayList<>();
strings.add(" ");
strings.add("You may have to have Administrator rights to avoid the following error message:");
return strings;
}
public static void addDecodeHint(final List strings) {
strings.add(" ");
strings.add(" Diagram source: (Use http://zxing.org/w/decode.jspx to decode the qrcode)");
}
public static void addProperties(final List strings) {
// ::comment when __CORE__
strings.addAll(OptionPrint.interestingProperties());
strings.addAll(OptionPrint.interestingValues());
}
public boolean isHidden() {
return false;
}
public HColor getBackcolor() {
return HColors.WHITE;
}
public XDimension2D calculateDimension(StringBounder stringBounder) {
return getMain().calculateDimension(stringBounder);
}
public void drawU(UGraphic ug) {
getMain().drawU(ug);
}
private TextBlock getMain() {
TextBlock result = text1;
// ::comment when __CORE__
if (flashCode != null) {
final UImage flash = new UImage(new PixelImage(flashCode, AffineTransformType.TYPE_NEAREST_NEIGHBOR))
.scale(3);
result = TextBlockUtils.mergeTB(result, flash, HorizontalAlignment.LEFT);
}
if (graphviz244onWindows) {
final TextBlock text2 = GraphicStrings.createBlackOnWhite(getText2());
result = TextBlockUtils.mergeTB(result, text2, HorizontalAlignment.LEFT);
final UImage dotc = new UImage(new PixelImage(PSystemVersion.getDotc(), AffineTransformType.TYPE_BILINEAR));
result = TextBlockUtils.mergeTB(result, dotc, HorizontalAlignment.LEFT);
final TextBlock text3 = GraphicStrings.createBlackOnWhite(getText3());
result = TextBlockUtils.mergeTB(result, text3, HorizontalAlignment.LEFT);
final UImage dotd = new UImage(new PixelImage(PSystemVersion.getDotd(), AffineTransformType.TYPE_BILINEAR));
result = TextBlockUtils.mergeTB(result, dotd, HorizontalAlignment.LEFT);
}
return result;
}
public ShapeType getShapeType() {
return ShapeType.RECTANGLE;
}
public Margins getShield(StringBounder stringBounder) {
return Margins.NONE;
}
public double getOverscanX(StringBounder stringBounder) {
return 0;
}
}