mirror of https://github.com/octoleo/plantuml.git
383 lines
14 KiB
Java
383 lines
14 KiB
Java
/* ========================================================================
|
|
* PlantUML : a free UML diagram generator
|
|
* ========================================================================
|
|
*
|
|
* (C) Copyright 2009-2020, Arnaud Roques
|
|
*
|
|
* Project Info: http://plantuml.com
|
|
*
|
|
* If you like this project or if you find it useful, you can support us at:
|
|
*
|
|
* http://plantuml.com/patreon (only 1$ per month!)
|
|
* http://plantuml.com/paypal
|
|
*
|
|
* This file is part of PlantUML.
|
|
*
|
|
* PlantUML is free software; you can redistribute it and/or modify it
|
|
* under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* PlantUML distributed in the hope that it will be useful, but
|
|
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
|
|
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
|
|
* License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public
|
|
* License along with this library; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
|
|
* USA.
|
|
*
|
|
*
|
|
* Original Author: Arnaud Roques
|
|
* Modified by: Nicolas Jouanin
|
|
*
|
|
*
|
|
*/
|
|
package net.sourceforge.plantuml.preproc2;
|
|
|
|
import java.io.File;
|
|
import java.io.IOException;
|
|
import java.io.InputStream;
|
|
import java.io.InputStreamReader;
|
|
import java.io.Reader;
|
|
import java.net.MalformedURLException;
|
|
import java.net.URL;
|
|
import java.util.HashSet;
|
|
import java.util.List;
|
|
import java.util.Set;
|
|
import java.util.regex.Matcher;
|
|
import java.util.regex.Pattern;
|
|
|
|
import net.sourceforge.plantuml.DefinitionsContainer;
|
|
import net.sourceforge.plantuml.FileSystem;
|
|
import net.sourceforge.plantuml.Log;
|
|
import net.sourceforge.plantuml.OptionFlags;
|
|
import net.sourceforge.plantuml.StringLocated;
|
|
import net.sourceforge.plantuml.StringUtils;
|
|
import net.sourceforge.plantuml.command.regex.Matcher2;
|
|
import net.sourceforge.plantuml.command.regex.MyPattern;
|
|
import net.sourceforge.plantuml.command.regex.Pattern2;
|
|
import net.sourceforge.plantuml.preproc.DefinesGet;
|
|
import net.sourceforge.plantuml.preproc.FileWithSuffix;
|
|
import net.sourceforge.plantuml.preproc.ImportedFiles;
|
|
import net.sourceforge.plantuml.preproc.ReadLine;
|
|
import net.sourceforge.plantuml.preproc.ReadLineEmpty;
|
|
import net.sourceforge.plantuml.preproc.ReadLineList;
|
|
import net.sourceforge.plantuml.preproc.ReadLineReader;
|
|
import net.sourceforge.plantuml.preproc.ReadLineSimple;
|
|
import net.sourceforge.plantuml.preproc.ReadLineSingle;
|
|
import net.sourceforge.plantuml.preproc.StartDiagramExtractReader;
|
|
import net.sourceforge.plantuml.preproc.Stdlib;
|
|
import net.sourceforge.plantuml.tim.EaterException;
|
|
import net.sourceforge.plantuml.utils.StartUtils;
|
|
|
|
public class PreprocessorInclude implements ReadFilter {
|
|
|
|
private static final Pattern2 includeDefPattern = MyPattern.cmpile("^[%s]*!includedef[%s]+[%g]?([^%g]+)[%g]?$");
|
|
|
|
private static final Pattern2 includeDefaultStrategy = MyPattern.cmpile("^[%s]*!default_include[%s]+(once|many)$");
|
|
|
|
private static final Pattern2 includePattern = MyPattern.cmpile("^[%s]*!include[%s]+[%g]?([^%g]+)[%g]?$");
|
|
private static final Pattern2 includeManyPattern = MyPattern.cmpile("^[%s]*!include_many[%s]+[%g]?([^%g]+)[%g]?$");
|
|
private static final Pattern2 includeOncePattern = MyPattern.cmpile("^[%s]*!include_once[%s]+[%g]?([^%g]+)[%g]?$");
|
|
|
|
private static final Pattern2 importPattern = MyPattern.cmpile("^[%s]*!import[%s]+[%g]?([^%g]+)[%g]?$");
|
|
private static final Pattern2 includePatternStdlib = MyPattern.cmpile("^[%s]*!include[%s]+(\\<[^%g]+\\>)$");
|
|
private static final Pattern2 includeURLPattern = MyPattern.cmpile("^[%s]*!includeurl[%s]+[%g]?([^%g]+)[%g]?$");
|
|
|
|
private final String charset;
|
|
private final DefinesGet defines;
|
|
private final List<String> config;
|
|
private final DefinitionsContainer definitionsContainer;
|
|
private final ImportedFiles importedFiles;
|
|
|
|
private final Set<FileWithSuffix> filesUsedCurrent = new HashSet<FileWithSuffix>();
|
|
private final Set<FileWithSuffix> filesUsedGlobal;
|
|
private PreprocessorIncludeStrategy strategy = PreprocessorIncludeStrategy.ONCE;
|
|
|
|
public PreprocessorInclude(List<String> config, String charset, DefinesGet defines,
|
|
DefinitionsContainer definitionsContainer, ImportedFiles importedFiles, Set<FileWithSuffix> filesUsedGlobal) {
|
|
this.charset = charset;
|
|
this.config = config;
|
|
this.defines = defines;
|
|
this.definitionsContainer = definitionsContainer;
|
|
this.importedFiles = importedFiles;
|
|
this.filesUsedGlobal = filesUsedGlobal;
|
|
}
|
|
|
|
public ReadLine applyFilter(ReadLine source) {
|
|
return new Inner(source);
|
|
}
|
|
|
|
class Inner extends ReadLineInsertable {
|
|
|
|
final ReadLine source;
|
|
|
|
Inner(ReadLine source) {
|
|
this.source = source;
|
|
}
|
|
|
|
@Override
|
|
void closeInternal() throws IOException {
|
|
source.close();
|
|
}
|
|
|
|
@Override
|
|
StringLocated readLineInternal() throws IOException {
|
|
final StringLocated s = source.readLine();
|
|
if (s == null || s.getPreprocessorError() != null) {
|
|
return s;
|
|
}
|
|
if (s != null && StartUtils.startOrEnd(s)) {
|
|
// http://plantuml.sourceforge.net/qa/?qa=3389/error-generating-when-same-file-included-different-diagram
|
|
filesUsedCurrent.clear();
|
|
strategy = PreprocessorIncludeStrategy.ONCE;
|
|
return s;
|
|
}
|
|
if (s.getPreprocessorError() == null && OptionFlags.ALLOW_INCLUDE) {
|
|
final Matcher2 m0 = importPattern.matcher(s.getString());
|
|
if (m0.find()) {
|
|
final StringLocated err = manageFileImport(s, m0);
|
|
if (err != null) {
|
|
insert(new ReadLineSingle(err));
|
|
}
|
|
return readLine();
|
|
}
|
|
final Matcher2 m1 = includePattern.matcher(s.getString());
|
|
if (m1.find()) {
|
|
insert(manageFileInclude(s, m1, strategy));
|
|
return readLine();
|
|
}
|
|
final Matcher2 m2 = includeManyPattern.matcher(s.getString());
|
|
if (m2.find()) {
|
|
insert(manageFileInclude(s, m2, PreprocessorIncludeStrategy.MANY));
|
|
return readLine();
|
|
}
|
|
final Matcher2 m3 = includeOncePattern.matcher(s.getString());
|
|
if (m3.find()) {
|
|
insert(manageFileInclude(s, m3, PreprocessorIncludeStrategy.ONCE));
|
|
return readLine();
|
|
}
|
|
final Matcher2 m4 = includeDefPattern.matcher(s.getString());
|
|
if (m4.find()) {
|
|
insert(manageDefinitionInclude(s, m4));
|
|
return readLine();
|
|
}
|
|
} else {
|
|
final Matcher2 m1 = includePatternStdlib.matcher(s.getString());
|
|
if (m1.find()) {
|
|
insert(manageFileInclude(s, m1, PreprocessorIncludeStrategy.ONCE));
|
|
return readLine();
|
|
}
|
|
}
|
|
final Matcher2 mUrl = includeURLPattern.matcher(s.getString());
|
|
if (s.getPreprocessorError() == null && mUrl.find()) {
|
|
insert(manageUrlInclude(s, mUrl));
|
|
return readLine();
|
|
}
|
|
final Matcher2 m2 = includeDefaultStrategy.matcher(s.getString());
|
|
if (m2.find()) {
|
|
strategy = PreprocessorIncludeStrategy.fromString(m2.group(1));
|
|
return readLine();
|
|
}
|
|
|
|
return s;
|
|
}
|
|
|
|
}
|
|
|
|
private StringLocated manageFileImport(StringLocated s, Matcher2 m) throws IOException {
|
|
final String fileName = m.group(1);
|
|
final File file = FileSystem.getInstance().getFile(withEnvironmentVariable(fileName));
|
|
if (file.exists() && file.isDirectory() == false) {
|
|
importedFiles.add(file);
|
|
return null;
|
|
}
|
|
return s.withErrorPreprocessor("Cannot import " + FileWithSuffix.getFileName(file));
|
|
|
|
}
|
|
|
|
private ReadLine manageUrlInclude(StringLocated s, Matcher2 m) throws IOException {
|
|
String urlString = m.group(1);
|
|
urlString = defines.get().applyDefines(urlString).get(0);
|
|
|
|
final int idx = urlString.lastIndexOf('!');
|
|
String suf = null;
|
|
if (idx != -1) {
|
|
suf = urlString.substring(idx + 1);
|
|
urlString = urlString.substring(0, idx);
|
|
}
|
|
try {
|
|
if (urlString.toLowerCase().startsWith("https://") == false
|
|
&& urlString.toLowerCase().startsWith("http://") == false) {
|
|
return new ReadLineSingle(s.withErrorPreprocessor("Cannot include url " + urlString));
|
|
}
|
|
final URL url = new URL(urlString);
|
|
return new Preprocessor(config, getReaderIncludeUrl(url, s, suf, charset), charset, defines, definitionsContainer,
|
|
filesUsedGlobal, importedFiles, false);
|
|
|
|
} catch (MalformedURLException e) {
|
|
return new ReadLineSingle(s.withErrorPreprocessor("Cannot include url " + urlString));
|
|
}
|
|
}
|
|
|
|
private ReadLine manageDefinitionInclude(StringLocated s, Matcher2 matcher) throws IOException {
|
|
final String definitionName = matcher.group(1);
|
|
final List<String> definition = definitionsContainer.getDefinition1(definitionName);
|
|
return new Preprocessor(config, new ReadLineList(definition, s.getLocation()), charset, defines,
|
|
definitionsContainer, filesUsedGlobal, importedFiles, false);
|
|
}
|
|
|
|
private ReadLine manageFileInclude(StringLocated s, Matcher2 matcher, PreprocessorIncludeStrategy allowMany)
|
|
throws IOException {
|
|
String fileName = matcher.group(1);
|
|
fileName = defines.get().applyDefines(fileName).get(0);
|
|
if (fileName.startsWith("<") && fileName.endsWith(">")) {
|
|
final ReadLine strlibReader = getReaderStdlibInclude(s, fileName.substring(1, fileName.length() - 1));
|
|
if (strlibReader == null) {
|
|
return new ReadLineSingle(s.withErrorPreprocessor("Cannot include " + fileName));
|
|
}
|
|
return new Preprocessor(config, strlibReader, charset, defines, definitionsContainer, filesUsedGlobal,
|
|
importedFiles, false);
|
|
}
|
|
final int idx = fileName.lastIndexOf('!');
|
|
String suf = null;
|
|
if (idx != -1) {
|
|
suf = fileName.substring(idx + 1);
|
|
fileName = fileName.substring(0, idx);
|
|
}
|
|
final FileWithSuffix f2 = new FileWithSuffix(importedFiles, withEnvironmentVariable(fileName), suf);
|
|
if (f2.fileOk() == false) {
|
|
Log.error("Current path is " + FileWithSuffix.getAbsolutePath(new File(".")));
|
|
Log.error("Cannot include " + f2.getDescription());
|
|
return new ReadLineSingle(s.withErrorPreprocessor("Cannot include " + f2.getDescription()));
|
|
} else if (allowMany == PreprocessorIncludeStrategy.ONCE && filesUsedCurrent.contains(f2)) {
|
|
// return new ReadLineSimple(s, "File already included " + f2.getDescription());
|
|
return new ReadLineEmpty();
|
|
}
|
|
filesUsedCurrent.add(f2);
|
|
filesUsedGlobal.add(f2);
|
|
|
|
return new Preprocessor(config, getReaderInclude(f2, s), charset, defines, definitionsContainer,
|
|
filesUsedGlobal, importedFiles.withCurrentDir(f2.getParentFile()), false);
|
|
}
|
|
|
|
public static String withEnvironmentVariable(String s) {
|
|
final Pattern p = Pattern.compile("%(\\w+)%");
|
|
|
|
final Matcher m = p.matcher(s);
|
|
final StringBuffer sb = new StringBuffer();
|
|
while (m.find()) {
|
|
final String var = m.group(1);
|
|
final String value = getenv(var);
|
|
if (value != null) {
|
|
m.appendReplacement(sb, Matcher.quoteReplacement(value));
|
|
}
|
|
}
|
|
m.appendTail(sb);
|
|
s = sb.toString();
|
|
return s;
|
|
}
|
|
|
|
public static String getenv(String var) {
|
|
final String env = System.getProperty(var);
|
|
if (StringUtils.isNotEmpty(env)) {
|
|
return StringUtils.eventuallyRemoveStartingAndEndingDoubleQuote(env);
|
|
}
|
|
final String getenv = System.getenv(var);
|
|
if (StringUtils.isNotEmpty(getenv)) {
|
|
return StringUtils.eventuallyRemoveStartingAndEndingDoubleQuote(getenv);
|
|
}
|
|
return null;
|
|
}
|
|
|
|
private static InputStream getStdlibInputStream(String filename) {
|
|
final InputStream result = Stdlib.getResourceAsStream(filename);
|
|
// Log.info("Loading sdlib " + filename + " ok");
|
|
return result;
|
|
}
|
|
|
|
public static ReadLine getReaderStdlibInclude(StringLocated s, String filename) {
|
|
Log.info("Loading sdlib " + filename);
|
|
InputStream is = getStdlibInputStream(filename);
|
|
if (is == null) {
|
|
return null;
|
|
}
|
|
final String description = "<" + filename + ">";
|
|
try {
|
|
if (StartDiagramExtractReader.containsStartDiagram(is, s, description)) {
|
|
is = getStdlibInputStream(filename);
|
|
return StartDiagramExtractReader.build(is, s, description);
|
|
}
|
|
is = getStdlibInputStream(filename);
|
|
if (is == null) {
|
|
return null;
|
|
}
|
|
return ReadLineReader.create(new InputStreamReader(is), description);
|
|
} catch (IOException e) {
|
|
e.printStackTrace();
|
|
return new ReadLineSimple(s, e.toString());
|
|
}
|
|
}
|
|
|
|
private ReadLine getReaderInclude(FileWithSuffix f2, StringLocated s) {
|
|
try {
|
|
if (StartDiagramExtractReader.containsStartDiagram(f2, s, charset)) {
|
|
return StartDiagramExtractReader.build(f2, s, charset);
|
|
}
|
|
final Reader reader = f2.getReader(charset);
|
|
if (reader == null) {
|
|
return new ReadLineSimple(s, "Cannot open " + f2.getDescription());
|
|
}
|
|
return ReadLineReader.create(reader, f2.getDescription(), s.getLocation());
|
|
} catch (IOException e) {
|
|
e.printStackTrace();
|
|
return new ReadLineSimple(s, e.toString());
|
|
}
|
|
}
|
|
|
|
private static ReadLine getReaderIncludeUrl(final URL url, StringLocated s, String suf, String charset) {
|
|
try {
|
|
if (StartDiagramExtractReader.containsStartDiagram(url, s, charset)) {
|
|
return StartDiagramExtractReader.build(url, s, suf, charset);
|
|
}
|
|
final InputStream is = url.openStream();
|
|
if (charset == null) {
|
|
Log.info("Using default charset");
|
|
return ReadLineReader.create(new InputStreamReader(is), url.toString(), s.getLocation());
|
|
}
|
|
Log.info("Using charset " + charset);
|
|
return ReadLineReader.create(new InputStreamReader(is, charset), url.toString(), s.getLocation());
|
|
} catch (IOException e) {
|
|
e.printStackTrace();
|
|
return new ReadLineSimple(s, e.toString());
|
|
}
|
|
|
|
}
|
|
|
|
public static ReadLine getReaderIncludeUrl2(final URL url, StringLocated s, String suf, String charset) throws EaterException {
|
|
try {
|
|
if (StartDiagramExtractReader.containsStartDiagram(url, s, charset)) {
|
|
return StartDiagramExtractReader.build(url, s, suf, charset);
|
|
}
|
|
final InputStream is = url.openStream();
|
|
if (charset == null) {
|
|
Log.info("Using default charset");
|
|
return ReadLineReader.create(new InputStreamReader(is), url.toString(), s.getLocation());
|
|
}
|
|
Log.info("Using charset " + charset);
|
|
return ReadLineReader.create(new InputStreamReader(is, charset), url.toString(), s.getLocation());
|
|
} catch (IOException e) {
|
|
e.printStackTrace();
|
|
throw new EaterException("Cannot open URL");
|
|
}
|
|
|
|
}
|
|
|
|
public Set<FileWithSuffix> getFilesUsedGlobal() {
|
|
return filesUsedGlobal;
|
|
}
|
|
|
|
}
|