net.sourceforge.plantuml.FileUtils 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;
import java.io.BufferedInputStream;
import java.io.BufferedOutputStream;
import java.io.BufferedReader;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.OutputStream;
import java.util.Objects;
import java.util.concurrent.atomic.AtomicInteger;
import net.sourceforge.plantuml.security.SFile;
import net.sourceforge.plantuml.utils.Log;
// Used by the Eclipse Plugin, so do not change package location.
public class FileUtils {
// ::remove file when __HAXE__
private static AtomicInteger counter;
public static void resetCounter() {
counter = new AtomicInteger(0);
}
static public String readSvg(SFile svgFile) throws IOException {
final BufferedReader br = svgFile.openBufferedReader();
if (br == null)
return null;
return readSvg(br, false, true);
}
static public String readSvg(InputStream is) throws IOException {
final BufferedReader br = new BufferedReader(new InputStreamReader(is));
return readSvg(br, false, false);
}
static public void copyInternal(final InputStream fis, final OutputStream fos, boolean close) throws IOException {
final byte[] buf = new byte[10240];
int len;
while ((len = fis.read(buf)) > 0)
fos.write(buf, 0, len);
if (close) {
fos.close();
fis.close();
}
}
private static String readSvg(BufferedReader br, boolean withNewline, boolean withClose) throws IOException {
final StringBuilder sb = new StringBuilder();
String s;
while ((s = br.readLine()) != null) {
sb.append(s);
if (withNewline)
sb.append("\n");
}
if (withClose)
br.close();
return sb.toString();
}
static public String readText(InputStream is) throws IOException {
final BufferedReader br = new BufferedReader(new InputStreamReader(is));
return readSvg(br, true, true);
}
// ::comment when __CORE__
static public File createTempFileLegacy(String prefix, String suffix) throws IOException {
if (suffix.startsWith(".") == false)
throw new IllegalArgumentException();
Objects.requireNonNull(prefix);
final File f;
if (counter == null) {
f = File.createTempFile(prefix, suffix);
} else {
final String name = prefix + counter.addAndGet(1) + suffix;
f = new File(name);
}
Log.info("Creating temporary file: " + f);
f.deleteOnExit();
return f;
}
static public SFile createTempFile(String prefix, String suffix) throws IOException {
if (suffix.startsWith(".") == false)
throw new IllegalArgumentException();
Objects.requireNonNull(prefix);
final SFile f;
if (counter == null) {
f = SFile.createTempFile(prefix, suffix);
} else {
final String name = prefix + counter.addAndGet(1) + suffix;
f = new SFile(name);
}
Log.info("Creating temporary file: " + f);
f.deleteOnExit();
return f;
}
static public void copyToFile(SFile src, SFile dest) throws IOException {
if (dest.isDirectory())
dest = dest.file(src.getName());
final InputStream fis = src.openFile();
if (fis == null)
throw new FileNotFoundException();
final OutputStream fos = dest.createBufferedOutputStream();
copyInternal(fis, fos, true);
}
static public void copyToStream(SFile src, OutputStream os) throws IOException {
final InputStream fis = src.openFile();
if (fis == null)
throw new FileNotFoundException();
final OutputStream fos = new BufferedOutputStream(os);
copyInternal(fis, fos, true);
}
static public void copyToStream(File src, OutputStream os) throws IOException {
final InputStream fis = new BufferedInputStream(new FileInputStream(src));
final OutputStream fos = new BufferedOutputStream(os);
copyInternal(fis, fos, true);
}
static public void copyToStream(InputStream is, OutputStream os) throws IOException {
final InputStream fis = new BufferedInputStream(is);
final OutputStream fos = new BufferedOutputStream(os);
copyInternal(fis, fos, true);
}
static public void copyToFile(byte[] src, SFile dest) throws IOException {
try (OutputStream fos = dest.createBufferedOutputStream()) {
fos.write(src);
}
}
static public String readFile(SFile svgFile) throws IOException {
final BufferedReader br = svgFile.openBufferedReader();
if (br == null)
return null;
return readSvg(br, true, true);
}
}