net.sourceforge.plantuml.command.CommandSpriteFile 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.command;
import java.awt.image.BufferedImage;
import java.io.IOException;
import java.io.InputStream;
import java.util.zip.ZipEntry;
import java.util.zip.ZipInputStream;
import net.sourceforge.plantuml.FileSystem;
import net.sourceforge.plantuml.FileUtils;
import net.sourceforge.plantuml.TitledDiagram;
import net.sourceforge.plantuml.klimt.sprite.Sprite;
import net.sourceforge.plantuml.klimt.sprite.SpriteImage;
import net.sourceforge.plantuml.klimt.sprite.SpriteSvg;
import net.sourceforge.plantuml.regex.IRegex;
import net.sourceforge.plantuml.regex.RegexConcat;
import net.sourceforge.plantuml.regex.RegexLeaf;
import net.sourceforge.plantuml.regex.RegexResult;
import net.sourceforge.plantuml.security.SFile;
import net.sourceforge.plantuml.security.SImageIO;
import net.sourceforge.plantuml.utils.LineLocation;
import net.sourceforge.plantuml.utils.Log;
public class CommandSpriteFile extends SingleLineCommand2 {
public static final CommandSpriteFile ME = new CommandSpriteFile();
private CommandSpriteFile() {
super(getRegexConcat());
}
private static IRegex getRegexConcat() {
return RegexConcat.build(CommandSpriteFile.class.getName(), RegexLeaf.start(), //
new RegexLeaf("sprite"), //
RegexLeaf.spaceOneOrMore(), //
new RegexLeaf("\\$?"), //
new RegexLeaf("NAME", "([-%pLN_]+)"), //
RegexLeaf.spaceOneOrMore(), //
new RegexLeaf("FILE", "([^<>%g#]*)"), RegexLeaf.end());
}
@Override
protected CommandExecutionResult executeArg(TitledDiagram system, LineLocation location, RegexResult arg) {
// ::comment when __CORE__
final String src = arg.get("FILE", 0);
final Sprite sprite;
try {
if (src.startsWith("jar:")) {
final String inner = src.substring(4) + ".png";
final InputStream is = SpriteImage.getInternalSprite(inner);
if (is == null)
return CommandExecutionResult.error("No such internal sprite: " + inner);
sprite = new SpriteImage(SImageIO.read(is));
} else if (src.contains("~")) {
final int idx = src.lastIndexOf("~");
final SFile f = FileSystem.getInstance().getFile(src.substring(0, idx));
if (f.exists() == false)
return CommandExecutionResult.error("Cannot read: " + src);
final String name = src.substring(idx + 1);
sprite = getImageFromZip(f, name);
if (sprite == null)
return CommandExecutionResult.error("Cannot read: " + src);
} else {
final SFile f = FileSystem.getInstance().getFile(src);
if (f.exists() == false)
return CommandExecutionResult.error("Cannot read: " + src);
if (isSvg(f.getName())) {
final String tmp = FileUtils.readSvg(f);
if (tmp == null)
return CommandExecutionResult.error("Cannot read: " + src);
sprite = new SpriteSvg(tmp);
} else {
final BufferedImage tmp = f.readRasterImageFromFile();
if (tmp == null)
return CommandExecutionResult.error("Cannot read: " + src);
sprite = new SpriteImage(tmp);
}
}
} catch (IOException e) {
Log.error("Error reading " + src + " " + e);
return CommandExecutionResult.error("Cannot read: " + src);
}
system.addSprite(arg.get("NAME", 0), sprite);
return CommandExecutionResult.ok();
}
// ::comment when __CORE__
private Sprite getImageFromZip(SFile f, String name) throws IOException {
final InputStream tmp = f.openFile();
if (tmp == null) {
return null;
}
ZipInputStream zis = null;
try {
zis = new ZipInputStream(tmp);
ZipEntry ze = zis.getNextEntry();
while (ze != null) {
final String fileName = ze.getName();
if (ze.isDirectory()) {
} else if (fileName.equals(name)) {
if (isSvg(name))
return new SpriteSvg(FileUtils.readSvg(zis));
else
return new SpriteImage(SImageIO.read(zis));
}
ze = zis.getNextEntry();
}
} finally {
if (zis != null) {
zis.closeEntry();
zis.close();
}
}
return null;
}
private boolean isSvg(String name) {
return name.toLowerCase().endsWith(".svg");
}
}