net.sourceforge.plantuml.preproc.FileWithSuffix 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.preproc;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.Reader;
import java.nio.charset.Charset;
import java.util.HashSet;
import java.util.Set;
import java.util.zip.ZipEntry;
import java.util.zip.ZipInputStream;
import net.sourceforge.plantuml.file.AFile;
import net.sourceforge.plantuml.file.AFileRegular;
import net.sourceforge.plantuml.file.AParentFolder;
import net.sourceforge.plantuml.security.SFile;
import net.sourceforge.plantuml.utils.Log;
public class FileWithSuffix {
private final AFile file;
private final String suffix;
private final String entry;
private final String description;
@Override
public String toString() {
if (file == null) {
return super.toString();
}
return file.toString();
}
public Reader getReader(Charset charset) throws IOException {
if (file == null) {
return null;
}
final InputStream tmp = file.openFile();
if (tmp == null) {
return null;
}
if (entry == null) {
return new InputStreamReader(tmp, charset);
}
final InputStream is = getDataFromZip(tmp, entry);
if (is == null) {
return null;
}
return new InputStreamReader(is, charset);
}
private InputStream getDataFromZip(InputStream is, String name) throws IOException {
final ZipInputStream zis = new ZipInputStream(is);
ZipEntry ze = zis.getNextEntry();
while (ze != null) {
final String fileName = ze.getName();
if (ze.isDirectory()) {
} else if (fileName.equals(name)) {
return zis;
}
ze = zis.getNextEntry();
}
zis.closeEntry();
zis.close();
return null;
}
public boolean fileOk() {
return file != null && file.isOk();
}
FileWithSuffix(SFile file, String suffix) {
this.file = new AFileRegular(file);
this.suffix = suffix;
this.entry = null;
this.description = file.getName();
}
FileWithSuffix(String description, String suffix, AFile file, String entry) {
this.description = description;
this.suffix = suffix;
this.file = file;
this.entry = entry;
}
static FileWithSuffix none() {
return new FileWithSuffix("NONE", null, null, null);
}
@Override
public int hashCode() {
int v = 0;
if (file != null) {
v += file.hashCode();
}
if (suffix != null) {
v += suffix.hashCode() * 43;
}
if (entry != null) {
v += entry.hashCode();
}
return v;
}
@Override
public boolean equals(Object arg) {
final FileWithSuffix other = (FileWithSuffix) arg;
return this.file.equals(other.file) && equals(suffix, other.suffix) && same(entry, other.entry);
}
private static boolean same(String s1, String s2) {
if (s1 == null && s2 == null) {
return true;
}
if (s1 != null && s2 != null) {
return s1.equals(s2);
}
return false;
}
public AParentFolder getParentFile() {
if (file == null) {
return null;
}
Log.info("Getting parent of " + file);
Log.info("-->The parent is " + file.getParentFile());
return file.getParentFile();
}
public String getDescription() {
return description;
}
public final String getSuffix() {
return suffix;
}
private static boolean equals(String s1, String s2) {
if (s1 == null && s2 == null) {
return true;
}
if (s1 != null && s2 != null) {
return s1.equals(s2);
}
assert (s1 == null && s2 != null) || (s1 != null && s2 == null);
return false;
}
public static Set convert(Set all) throws FileNotFoundException {
final Set result = new HashSet<>();
for (FileWithSuffix f : all) {
result.add(f.file.getUnderlyingFile().conv());
}
return result;
}
public static String getFileName(File file) {
return file.getName();
}
}