net.sourceforge.plantuml.tim.stdlib.LoadJson Maven / Gradle / Ivy
// 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 Revised BSD License.
*
* All rights reserved.
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* * Neither the name of the University of California, Berkeley nor the
* names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* 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 BSD license.
*
* The generated images can then be used without any reference to the BSD 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.tim.stdlib;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.UnsupportedEncodingException;
import java.util.List;
import java.util.Map;
import java.util.Set;
import net.sourceforge.plantuml.FileSystem;
import net.sourceforge.plantuml.FileUtils;
import net.sourceforge.plantuml.json.Json;
import net.sourceforge.plantuml.json.JsonValue;
import net.sourceforge.plantuml.json.ParseException;
import net.sourceforge.plantuml.log.Logme;
import net.sourceforge.plantuml.security.SFile;
import net.sourceforge.plantuml.security.SURL;
import net.sourceforge.plantuml.text.StringLocated;
import net.sourceforge.plantuml.tim.EaterException;
import net.sourceforge.plantuml.tim.TContext;
import net.sourceforge.plantuml.tim.TFunctionSignature;
import net.sourceforge.plantuml.tim.TMemory;
import net.sourceforge.plantuml.tim.expression.TValue;
/**
* Loads JSON data from file or URL source.
*
* Supports three parameters for datasource, default JSON value and charset. The
* datasource will be checked against the security rules.
*
* Examples:
*
*
* @ startuml
* ' loads a local file
* !$JSON_LOCAL_RELATIVE=%load_json("file.json")
*
* ' loads a local file from an absolute file path
* !$JSON_LOCAL_ABS=%load_json("c:/loaded/data/file.json")
*
* ' tries to load a local file and returns an empty JSON
* !$JSON_LOCAL_REL_EMPTY=%load_json("file-not-existing.json")
*
* ' tries to load a local file and returns an default JSON
* !$DEF_JSON={"status":"No data found"}
* !$JSON_LOCAL_REL_DEF=%load_json("file-not-existing.json", $DEF_JSON)
*
* ' loads a local file with a specific charset (default is UTF-8)
* !$JSON_LOCAL_RELATIVE_CHARSET=%load_json("file.json", "{}", "iso-8859-1")
*
* ' loads a remote JSON from an endpoint (and default, if not reachable)
* !$STATUS_NO_CONNECTION={"status": "No connection"}
* !$JSON_REMOTE_DEF=%load_json("https://localhost:7778/management/health", $STATUS_NO_CONNECTION)
* status -> $JSON_REMOTE_DEF.status
* @ enduml
*
*
* @author Aljoscha Rittner
*/
public class LoadJson extends SimpleReturnFunction {
private static final String VALUE_CHARSET_DEFAULT = "UTF-8";
private static final String VALUE_DEFAULT_DEFAULT = "{}";
public TFunctionSignature getSignature() {
return new TFunctionSignature("%load_json", 3);
}
@Override
public boolean canCover(int nbArg, Set namedArgument) {
return nbArg == 1 || nbArg == 2 || nbArg == 3;
}
@Override
public TValue executeReturnFunction(TContext context, TMemory memory, StringLocated location, List values,
Map named) throws EaterException {
final String path = values.get(0).toString();
try {
String data = loadStringData(path, getCharset(values));
if (data == null)
data = getDefaultJson(values);
JsonValue jsonValue = Json.parse(data);
return TValue.fromJson(jsonValue);
} catch (ParseException pe) {
Logme.error(pe);
throw new EaterException("JSON parse issue in source " + path + " on location " + pe.getLocation(), location);
} catch (UnsupportedEncodingException e) {
Logme.error(e);
throw new EaterException("JSON encoding issue in source " + path + ": " + e.getMessage(), location);
}
}
/**
* Returns the JSON default, if the data source contains no data.
*
* @param values value parameters
* @return the defined default JSON or {@code "{}"}
*/
private String getDefaultJson(List values) {
if (values.size() > 1)
return values.get(1).toString();
return VALUE_DEFAULT_DEFAULT;
}
/**
* Returns the charset name (if set)
*
* @param values value parameters
* @return defined charset or {@code "UTF-8"}
*/
private String getCharset(List values) {
if (values.size() == 3)
return values.get(2).toString();
return VALUE_CHARSET_DEFAULT;
}
/**
* Loads String data from a data source {@code path} (file or URL) and expects
* the data encoded in {@code charset}.
*
* @param path path to data source (http(s)-URL or file).
* @param charset character set to encode the string data
* @return the decoded String from the data source
* @throws EaterException if something went wrong on reading data
*/
private String loadStringData(String path, String charset)
throws EaterException, UnsupportedEncodingException {
byte[] byteData = null;
if (path.startsWith("http://") || path.startsWith("https://")) {
final SURL url = SURL.create(path);
if (url != null)
byteData = url.getBytes();
// ::comment when __CORE__
} else {
try {
final SFile file = FileSystem.getInstance().getFile(path);
if (file != null && file.exists() && file.canRead() && !file.isDirectory()) {
final ByteArrayOutputStream out = new ByteArrayOutputStream(1024 * 8);
FileUtils.copyToStream(file, out);
byteData = out.toByteArray();
}
} catch (IOException e) {
Logme.error(e);
}
}
if (byteData == null || byteData.length == 0)
return null; // no length, no data (we want the default)
return new String(byteData, charset);
}
}