/**
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*/
package org.apache.camel.tools.apt.helper;
import java.io.File;
import java.net.URI;
import java.net.URL;
import java.util.ArrayList;
import java.util.Date;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
/**
* A helper class for <a href="http://json-schema.org/">JSON schema</a>.
*/
public final class JsonSchemaHelper {
private static final String VALID_CHARS = ".-='/\\!&():;";
// 0 = text, 1 = enum, 2 = boolean, 3 = integer or number
private static final Pattern PATTERN = Pattern.compile("\"(.+?)\"|\\[(.+)\\]|(true|false)|(-?\\d+\\.?\\d*)");
private static final String QUOT = """;
private JsonSchemaHelper() {
}
public static String toJson(String name, String displayName, String kind, Boolean required, String type, String defaultValue, String description,
Boolean deprecated, Boolean secret, String group, String label, boolean enumType, Set<String> enums,
boolean oneOfType, Set<String> oneOffTypes, boolean asPredicate, String optionalPrefix, String prefix, boolean multiValue) {
String typeName = JsonSchemaHelper.getType(type, enumType);
StringBuilder sb = new StringBuilder();
sb.append(Strings.doubleQuote(name));
sb.append(": { \"kind\": ");
sb.append(Strings.doubleQuote(kind));
// compute a display name if we don't have anything
if (Strings.isNullOrEmpty(displayName)) {
displayName = Strings.asTitle(name);
}
// we want display name early so its easier to spot
sb.append(", \"displayName\": ");
sb.append(Strings.doubleQuote(displayName));
// we want group early so its easier to spot
if (!Strings.isNullOrEmpty(group)) {
sb.append(", \"group\": ");
sb.append(Strings.doubleQuote(group));
}
// we want label early so its easier to spot
if (!Strings.isNullOrEmpty(label)) {
sb.append(", \"label\": ");
sb.append(Strings.doubleQuote(label));
}
if (required != null) {
// boolean type
sb.append(", \"required\": ");
sb.append(required.toString());
}
sb.append(", \"type\": ");
if ("enum".equals(typeName)) {
String actualType = JsonSchemaHelper.getType(type, false);
sb.append(Strings.doubleQuote(actualType));
sb.append(", \"javaType\": \"" + type + "\"");
CollectionStringBuffer enumValues = new CollectionStringBuffer();
for (Object value : enums) {
enumValues.append(Strings.doubleQuote(value.toString()));
}
sb.append(", \"enum\": [ ");
sb.append(enumValues.toString());
sb.append(" ]");
} else if (oneOfType) {
sb.append(Strings.doubleQuote(typeName));
sb.append(", \"javaType\": \"" + type + "\"");
CollectionStringBuffer oneOfValues = new CollectionStringBuffer();
for (Object value : oneOffTypes) {
oneOfValues.append(Strings.doubleQuote(value.toString()));
}
sb.append(", \"oneOf\": [ ");
sb.append(oneOfValues.toString());
sb.append(" ]");
} else if ("array".equals(typeName)) {
sb.append(Strings.doubleQuote("array"));
sb.append(", \"javaType\": \"" + type + "\"");
} else {
sb.append(Strings.doubleQuote(typeName));
sb.append(", \"javaType\": \"" + type + "\"");
}
if (!Strings.isNullOrEmpty(optionalPrefix)) {
sb.append(", \"optionalPrefix\": ");
String text = safeDefaultValue(optionalPrefix);
sb.append(Strings.doubleQuote(text));
}
if (!Strings.isNullOrEmpty(prefix)) {
sb.append(", \"prefix\": ");
String text = safeDefaultValue(prefix);
sb.append(Strings.doubleQuote(text));
}
if (multiValue) {
// boolean value
sb.append(", \"multiValue\": true");
}
if (deprecated != null) {
sb.append(", \"deprecated\": ");
// boolean value
sb.append(deprecated.toString());
}
if (secret != null) {
sb.append(", \"secret\": ");
// boolean value
sb.append(secret.toString());
}
if (!Strings.isNullOrEmpty(defaultValue)) {
sb.append(", \"defaultValue\": ");
String text = safeDefaultValue(defaultValue);
// the type can either be boolean, integer, number or text based
if ("boolean".equals(typeName) || "integer".equals(typeName) || "number".equals(typeName)) {
sb.append(text);
} else {
// text should be quoted
sb.append(Strings.doubleQuote(text));
}
}
// for expressions we want to know if it must be used as predicate or not
boolean predicate = "expression".equals(kind) || asPredicate;
if (predicate) {
sb.append(", \"asPredicate\": ");
if (asPredicate) {
sb.append("true");
} else {
sb.append("false");
}
}
if (!Strings.isNullOrEmpty(description)) {
sb.append(", \"description\": ");
String text = sanitizeDescription(description, false);
sb.append(Strings.doubleQuote(text));
}
sb.append(" }");
return sb.toString();
}
/**
* Gets the JSon schema type.
*
* @param type the java type
* @return the json schema type, is never null, but returns <tt>object</tt> as the generic type
*/
public static String getType(String type, boolean enumType) {
if (enumType) {
return "enum";
} else if (type == null) {
// return generic type for unknown type
return "object";
} else if (type.equals(URI.class.getName()) || type.equals(URL.class.getName())) {
return "string";
} else if (type.equals(File.class.getName())) {
return "string";
} else if (type.equals(Date.class.getName())) {
return "string";
} else if (type.startsWith("java.lang.Class")) {
return "string";
} else if (type.startsWith("java.util.List") || type.startsWith("java.util.Collection")) {
return "array";
}
String primitive = getPrimitiveType(type);
if (primitive != null) {
return primitive;
}
return "object";
}
/**
* Gets the JSon schema primitive type.
*
* @param name the java type
* @return the json schema primitive type, or <tt>null</tt> if not a primitive
*/
public static String getPrimitiveType(String name) {
// special for byte[] or Object[] as its common to use
if ("java.lang.byte[]".equals(name) || "byte[]".equals(name)) {
return "string";
} else if ("java.lang.Byte[]".equals(name) || "Byte[]".equals(name)) {
return "array";
} else if ("java.lang.Object[]".equals(name) || "Object[]".equals(name)) {
return "array";
} else if ("java.lang.String[]".equals(name) || "String[]".equals(name)) {
return "array";
} else if ("java.lang.Character".equals(name) || "Character".equals(name) || "char".equals(name)) {
return "string";
} else if ("java.lang.String".equals(name) || "String".equals(name)) {
return "string";
} else if ("java.lang.Boolean".equals(name) || "Boolean".equals(name) || "boolean".equals(name)) {
return "boolean";
} else if ("java.lang.Integer".equals(name) || "Integer".equals(name) || "int".equals(name)) {
return "integer";
} else if ("java.lang.Long".equals(name) || "Long".equals(name) || "long".equals(name)) {
return "integer";
} else if ("java.lang.Short".equals(name) || "Short".equals(name) || "short".equals(name)) {
return "integer";
} else if ("java.lang.Byte".equals(name) || "Byte".equals(name) || "byte".equals(name)) {
return "integer";
} else if ("java.lang.Float".equals(name) || "Float".equals(name) || "float".equals(name)) {
return "number";
} else if ("java.lang.Double".equals(name) || "Double".equals(name) || "double".equals(name)) {
return "number";
}
return null;
}
/**
* Sanitizes the javadoc to removed invalid characters so it can be used as json description
*
* @param javadoc the javadoc
* @return the text that is valid as json
*/
public static String sanitizeDescription(String javadoc, boolean summary) {
if (Strings.isNullOrEmpty(javadoc)) {
return null;
}
// lets just use what java accepts as identifiers
StringBuilder sb = new StringBuilder();
// split into lines
String[] lines = javadoc.split("\n");
boolean first = true;
for (String line : lines) {
line = line.trim();
// terminate if we reach @param, @return or @deprecated as we only want the javadoc summary
if (line.startsWith("@param") || line.startsWith("@return") || line.startsWith("@deprecated")) {
break;
}
// skip lines that are javadoc references
if (line.startsWith("@")) {
continue;
}
// remove all XML tags
line = line.replaceAll("<.*?>", "");
// remove all inlined javadoc links, eg such as {@link org.apache.camel.spi.Registry}
line = line.replaceAll("\\{\\@\\w+\\s([\\w.]+)\\}", "$1");
// we are starting from a new line, so add a whitespace
if (!first) {
sb.append(' ');
}
// create a new line
StringBuilder cb = new StringBuilder();
for (char c : line.toCharArray()) {
if (Character.isJavaIdentifierPart(c) || VALID_CHARS.indexOf(c) != -1) {
cb.append(c);
} else if (Character.isWhitespace(c)) {
// always use space as whitespace, also for line feeds etc
cb.append(' ');
}
}
// append data
String s = cb.toString().trim();
sb.append(s);
boolean empty = Strings.isNullOrEmpty(s);
boolean endWithDot = s.endsWith(".");
boolean haveText = sb.length() > 0;
if (haveText && summary && (empty || endWithDot)) {
// if we only want a summary, then skip at first empty line we encounter, or if the sentence ends with a dot
break;
}
first = false;
}
// remove double whitespaces, and trim
String s = sb.toString();
s = s.replaceAll("\\s+", " ");
return s.trim();
}
/**
* Parses the json schema to split it into a list or rows, where each row contains key value pairs with the metadata
*
* @param group the group to parse from such as <tt>component</tt>, <tt>componentProperties</tt>, or <tt>properties</tt>.
* @param json the json
* @return a list of all the rows, where each row is a set of key value pairs with metadata
*/
public static List<Map<String, String>> parseJsonSchema(String group, String json, boolean parseProperties) {
List<Map<String, String>> answer = new ArrayList<Map<String, String>>();
if (json == null) {
return answer;
}
boolean found = false;
// parse line by line
String[] lines = json.split("\n");
for (String line : lines) {
// we need to find the group first
if (!found) {
String s = line.trim();
found = s.startsWith("\"" + group + "\":") && s.endsWith("{");
continue;
}
// we should stop when we end the group
if (line.equals(" },") || line.equals(" }")) {
break;
}
// need to safe encode \" so we can parse the line
line = line.replaceAll("\"\\\\\"\"", '"' + QUOT + '"');
Map<String, String> row = new LinkedHashMap<String, String>();
Matcher matcher = PATTERN.matcher(line);
String key;
if (parseProperties) {
// when parsing properties the first key is given as name, so the first parsed token is the value of the name
key = "name";
} else {
key = null;
}
while (matcher.find()) {
if (key == null) {
key = matcher.group(1);
} else {
String value = matcher.group(1);
if (value != null) {
// its text based
value = value.trim();
// decode
value = value.replaceAll(QUOT, "\"");
value = decodeJson(value);
}
if (value == null) {
// not text then its maybe an enum?
value = matcher.group(2);
if (value != null) {
// its an enum so strip out " and trim spaces after comma
value = value.replaceAll("\"", "");
value = value.replaceAll(", ", ",");
value = value.trim();
}
}
if (value == null) {
// not text then its maybe a boolean?
value = matcher.group(3);
}
if (value == null) {
// not text then its maybe a integer?
value = matcher.group(4);
}
if (value != null) {
row.put(key, value);
}
// reset
key = null;
}
}
if (!row.isEmpty()) {
answer.add(row);
}
}
return answer;
}
private static String decodeJson(String value) {
// json encodes a \ as \\ so we need to decode from \\ back to \
if ("\\\\".equals(value)) {
value = "\\";
}
return value;
}
/**
* The default value may need to be escaped to be safe for json
*/
private static String safeDefaultValue(String value) {
if ("\"".equals(value)) {
return "\\\"";
} else if ("\\".equals(value)) {
return "\\\\";
} else {
return value;
}
}
}