Skip to content

Commit

Permalink
Fixed key escaping; fixed list/map property extraction.
Browse files Browse the repository at this point in the history
  • Loading branch information
@sdedic
sdedic committed Feb 19, 2023
1 parent 795e1d8 commit b3dca4a
Show file tree
Hide file tree
Showing 5 changed files with 271 additions and 100 deletions.
261 changes: 172 additions & 89 deletions ...radle-tooling/src/main/java/org/netbeans/modules/gradle/tooling/NbProjectInfoBuilder.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,7 @@
import org.gradle.api.plugins.ExtensionAware;
import org.gradle.api.plugins.ExtensionContainer;
import org.gradle.api.plugins.ExtensionsSchema.ExtensionSchema;
import org.gradle.api.plugins.ExtraPropertiesExtension;
import org.gradle.api.provider.Provider;
import org.gradle.api.reflect.HasPublicType;
import org.gradle.api.reflect.TypeOf;
Expand All @@ -100,6 +101,7 @@
import org.gradle.api.tasks.TaskDependency;
import org.gradle.api.tasks.bundling.Jar;
import org.gradle.api.tasks.testing.Test;
import org.gradle.internal.extensibility.DefaultExtraPropertiesExtension;
import org.gradle.jvm.JvmLibrary;
import org.gradle.language.base.artifact.SourcesArtifact;
import org.gradle.language.java.artifact.JavadocArtifact;
Expand All @@ -121,6 +123,11 @@ class NbProjectInfoBuilder {
* project loader is enabled to FINER level.
*/
private static final Logger LOG = Logging.getLogger(NbProjectInfoBuilder.class);

/**
* Name of the default extensibility point for various domain objects defined by Gradle.
*/
private static final String DEFAULT_EXTENSION_NAME = "ext"; // NOI18N

private static final String NB_PREFIX = "netbeans.";
private static final Set<String> CONFIG_EXCLUDES = new HashSet<>(asList( new String[]{
Expand Down Expand Up @@ -538,32 +545,45 @@ private boolean isMutableType(Object potentialValue) {
return adapter.isMutableType(potentialValue);
}

private void addNestedKeys(String prefix, Map<String, String> propertyTypes, Collection<String> keys) {
propertyTypes.merge(prefix + COLLECTION_KEYS_MARKER, String.join(";;", keys), (old, add) -> {
List<String> oldList = new ArrayList<>(Arrays.asList(old.split(";;")));
List<String> newList = Arrays.asList(add.split(";;"));
oldList.addAll(newList);
return String.join(";;", oldList);
});
}

private void inspectObjectAndValues0(Class clazz, Object object, String prefix, Map<String, Map<String, String>> globalTypes, Map<String, String> propertyTypes, Map<String, Object> defaultValues, Set<String> excludes, boolean type) {
Class nonDecorated = findNonDecoratedClass(clazz);

// record object's type first, even though the value may be excluded (i.e. ignored class). Do not add types for collection or map items -- to much clutter.
String typeKey = prefix;
if (prefix.endsWith(".")) {
typeKey = prefix.substring(0, prefix.length() - 1);
} else {
typeKey = prefix;
}
if (type) {
String typeKey = prefix;
if (prefix.endsWith(".")) {
typeKey = prefix.substring(0, prefix.length() - 1);
} else {
typeKey = prefix;
}
if (propertyTypes.putIfAbsent(typeKey, nonDecorated.getName()) != null && object == null) {
// type already introspected, no value to fetch properties from.
return;
}
}
if (clazz == null || (excludes == null && ignoreClassesPattern.matcher(clazz.getName()).matches())) {

if (clazz == null || clazz.isEnum()) {
return;
}
if (clazz.isEnum() || clazz.isArray()) {
if (clazz.isArray() || (excludes == null && ignoreClassesPattern.matcher(clazz.getName()).matches())) {
// try to dump as a list/map
dumpValue(object, typeKey, propertyTypes, defaultValues, clazz, null);
return;
}

MetaClass mclazz = GroovySystem.getMetaClassRegistry().getMetaClass(clazz);
Map<String, String> globTypes = globalTypes.computeIfAbsent(nonDecorated.getName(), cn -> new HashMap<>());
List<MetaProperty> props = mclazz.getProperties();
List<String> addedKeys = new ArrayList<>();
for (MetaProperty mp : props) {
Class propertyDeclaringClass = null;
String getterName = null;
Expand Down Expand Up @@ -658,6 +678,8 @@ private void inspectObjectAndValues0(Class clazz, Object object, String prefix,
}
}

addedKeys.add(propName);

String cn = findNonDecoratedClass(t).getName();
globTypes.put(propName, cn);
propertyTypes.put(prefix + propName, cn);
Expand All @@ -677,6 +699,7 @@ private void inspectObjectAndValues0(Class clazz, Object object, String prefix,
itemClass = findIterableItemClass(pubType.getConcreteClass());
}
propertyTypes.put(prefix + propName + COLLECTION_TYPE_MARKER, COLLECTION_TYPE_NAMED);
propertyTypes.put(prefix + propName, findNonDecoratedClass(t).getName());
if (itemClass != null) {
propertyTypes.put(prefix + propName + COLLECTION_ITEM_MARKER, itemClass.getName());
newPrefix = prefix + propName + COLLECTION_ITEM_PREFIX; // NOI18N
Expand All @@ -685,87 +708,10 @@ private void inspectObjectAndValues0(Class clazz, Object object, String prefix,

NamedDomainObjectContainer nc = (NamedDomainObjectContainer)value;
Map<String, ?> m = new HashMap<>(nc.getAsMap());
List<String> ss = new ArrayList<>(m.keySet());
propertyTypes.put(prefix + propName + COLLECTION_KEYS_MARKER, String.join(";;", ss));
for (String k : m.keySet()) {
newPrefix = prefix + propName + "." + k + "."; // NOI18N
Object v = m.get(k);
defaultValues.put(prefix + propName + "." + k, Objects.toString(v)); // NOI18N
inspectObjectAndValues(v.getClass(), v, newPrefix, globalTypes, propertyTypes, defaultValues, null, false);
}
dumpContainerProperties(m, prefix + propName, defaultValues);
dumped = true;
} else if (Iterable.class.isAssignableFrom(t)) {
itemClass = findIterableItemClass(t);
if (itemClass == null && typeParameters != null && !typeParameters.isEmpty()) {
if (typeParameters.get(0) instanceof Class) {
itemClass = (Class)typeParameters.get(0);
}
}

propertyTypes.put(prefix + propName + COLLECTION_TYPE_MARKER, COLLECTION_TYPE_LIST);
if (itemClass != null) {
cn = findNonDecoratedClass(itemClass).getName();
propertyTypes.put(prefix + propName + COLLECTION_ITEM_MARKER, cn);
String newPrefix = prefix + propName + COLLECTION_ITEM_PREFIX; // NOI18N
if (!cn.startsWith("java.lang.") && !Provider.class.isAssignableFrom(t)) { //NOI18N
inspectObjectAndValues(itemClass, null, newPrefix, globalTypes, propertyTypes, defaultValues);
}
}

if (value instanceof Iterable) {
int index = 0;
try {
for (Object o : (Iterable)value) {
String newPrefix = prefix + propName + "[" + index + "]."; // NOI18N
defaultValues.put(prefix + propName + "[" + index + "]", Objects.toString(o)); //NOI18N
inspectObjectAndValues(o.getClass(), o, newPrefix, globalTypes, propertyTypes, defaultValues, null, false);
index++;
}
} catch (RuntimeException ex) {
// values cannot be obtained
}
dumped = true;
}
} else if (value instanceof Map) {
Map mvalue = (Map)value;
Set<Object> ks = mvalue.keySet();
Class keyClass = findIterableItemClass(ks.getClass());
if (keyClass == null || keyClass == java.lang.Object.class) {
boolean ok = true;
for (Object k : ks) {
if (!(k instanceof String)) {
ok = false;
}
}
if (ok) {
keyClass = String.class;
}
}
if (keyClass == String.class) {
itemClass = findIterableItemClass(mvalue.values().getClass());

String keys = ks.stream().map(k -> k.toString()).map((String k) -> k.replace(";", "\\;")).collect(Collectors.joining(";;"));
propertyTypes.put(prefix + propName + COLLECTION_KEYS_MARKER, keys);

propertyTypes.put(prefix + propName + COLLECTION_TYPE_MARKER, COLLECTION_TYPE_MAP);
if (itemClass != null) {
cn = findNonDecoratedClass(itemClass).getName();
propertyTypes.put(prefix + propName + COLLECTION_ITEM_MARKER, cn);
String newPrefix = prefix + propName + COLLECTION_ITEM_PREFIX; // NOI18N
if (!cn.startsWith("java.lang.") && !Provider.class.isAssignableFrom(t)) { //NOI18N
inspectObjectAndValues(itemClass, null, newPrefix, globalTypes, propertyTypes, defaultValues);
}
}

for (Object o : ks) {
String k = o.toString();
String newPrefix = prefix + propName + "[" + k + "]"; // NOI18N
Object v = mvalue.get(o);
defaultValues.put(newPrefix, Objects.toString(v)); // NOI18N
inspectObjectAndValues(v.getClass(), v, newPrefix + ".", globalTypes, propertyTypes, defaultValues, null, itemClass == null);
}
dumped = true;
}
} else {
dumped = dumpValue(value, prefix + propName, propertyTypes, defaultValues, t, typeParameters);
}

if (!dumped) {
Expand All @@ -778,6 +724,134 @@ private void inspectObjectAndValues0(Class clazz, Object object, String prefix,
}
}
}
addNestedKeys(typeKey, propertyTypes, addedKeys);
}

private void dumpContainerProperties(Map m, String prefix, Map<String, Object> defaultValues) {
List<String> ss = new ArrayList<>(m.size());
for (Object o : m.keySet()) {
if (o instanceof String) {
ss.add((String)o);
}
}
// merge with other properties
addNestedKeys(prefix, propertyTypes, ss);

for (String k : ss) {
String newPrefix = prefix + "." + k + "."; // NOI18N
Object v = m.get(k);
defaultValues.put(prefix + "." + k, Objects.toString(v)); // NOI18N
inspectObjectAndValues(v.getClass(), v, newPrefix, globalTypes, propertyTypes, defaultValues, null, true);
}
}

private boolean dumpValue(Object value, String prefix, Map<String, String> propertyTypes, Map<String, Object> defaultValues, Class t, List<Type> typeParameters) {
// attemtp to enumerate membrs of a Container or an Iterable.
Class itemClass = null;
String cn = null;
boolean dumped = false;
if ((value instanceof NamedDomainObjectContainer) && (value instanceof HasPublicType)) {
String newPrefix;

TypeOf pubType = ((HasPublicType)value).getPublicType();
if (pubType != null && pubType.getComponentType() != null) {
itemClass = pubType.getComponentType().getConcreteClass();
} else {
itemClass = findIterableItemClass(pubType.getConcreteClass());
}
propertyTypes.put(prefix + COLLECTION_TYPE_MARKER, COLLECTION_TYPE_NAMED);
if (itemClass != null) {
propertyTypes.put(prefix + COLLECTION_ITEM_MARKER, itemClass.getName());
newPrefix = prefix + COLLECTION_ITEM_PREFIX; // NOI18N
inspectObjectAndValues(itemClass, null, newPrefix, globalTypes, propertyTypes, defaultValues);
}

NamedDomainObjectContainer nc = (NamedDomainObjectContainer)value;
Map<String, ?> m = new HashMap<>(nc.getAsMap());
List<String> ss = new ArrayList<>(m.keySet());
propertyTypes.put(prefix + COLLECTION_KEYS_MARKER, String.join(";;", ss));
for (String k : m.keySet()) {
newPrefix = prefix + "." + k + "."; // NOI18N
Object v = m.get(k);
defaultValues.put(prefix + "." + k, Objects.toString(v)); // NOI18N
inspectObjectAndValues(v.getClass(), v, newPrefix, globalTypes, propertyTypes, defaultValues, null, false);
}
dumped = true;
} else if (Iterable.class.isAssignableFrom(t)) {
itemClass = findIterableItemClass(t);
if (itemClass == null && typeParameters != null && !typeParameters.isEmpty()) {
if (typeParameters.get(0) instanceof Class) {
itemClass = (Class)typeParameters.get(0);
}
}

propertyTypes.put(prefix + COLLECTION_TYPE_MARKER, COLLECTION_TYPE_LIST);

if (itemClass != null) {
cn = findNonDecoratedClass(itemClass).getName();
propertyTypes.put(prefix + COLLECTION_ITEM_MARKER, cn);
String newPrefix = prefix + COLLECTION_ITEM_PREFIX; // NOI18N
if (!cn.startsWith("java.lang.") && !Provider.class.isAssignableFrom(t)) { //NOI18N
inspectObjectAndValues(itemClass, null, newPrefix, globalTypes, propertyTypes, defaultValues);
}
}

if (value instanceof Iterable) {
int index = 0;
try {
for (Object o : (Iterable)value) {
String newPrefix = prefix + "[" + index + "]."; // NOI18N
defaultValues.put(prefix + "[" + index + "]", Objects.toString(o)); //NOI18N
inspectObjectAndValues(o.getClass(), o, newPrefix, globalTypes, propertyTypes, defaultValues, null, false);
index++;
}
} catch (RuntimeException ex) {
// values cannot be obtained
}
dumped = true;
}
} else if (value instanceof Map) {
Map mvalue = (Map)value;
Set<Object> ks = mvalue.keySet();
Class keyClass = findIterableItemClass(ks.getClass());
if (keyClass == null || keyClass == java.lang.Object.class) {
boolean ok = true;
for (Object k : ks) {
if (!(k instanceof String)) {
ok = false;
}
}
if (ok) {
keyClass = String.class;
}
}
if (keyClass == String.class) {
itemClass = findIterableItemClass(mvalue.values().getClass());

String keys = ks.stream().map(k -> k.toString()).map((String k) -> k.replace(";", "\\;")).collect(Collectors.joining(";;"));
propertyTypes.put(prefix + COLLECTION_KEYS_MARKER, keys);

propertyTypes.put(prefix + COLLECTION_TYPE_MARKER, COLLECTION_TYPE_MAP);
if (itemClass != null) {
cn = findNonDecoratedClass(itemClass).getName();
propertyTypes.put(prefix + COLLECTION_ITEM_MARKER, cn);
String newPrefix = prefix + COLLECTION_ITEM_PREFIX; // NOI18N
if (!cn.startsWith("java.lang.") && !Provider.class.isAssignableFrom(t)) { //NOI18N
inspectObjectAndValues(itemClass, null, newPrefix, globalTypes, propertyTypes, defaultValues);
}
}

for (Object o : ks) {
String k = o.toString();
String newPrefix = prefix + "[" + k + "]"; // NOI18N
Object v = mvalue.get(o);
defaultValues.put(newPrefix, Objects.toString(v)); // NOI18N
inspectObjectAndValues(v.getClass(), v, newPrefix + ".", globalTypes, propertyTypes, defaultValues, null, itemClass == null);
}
dumped = true;
}
}
return dumped;
}

private static Class findNonDecoratedClass(Class clazz) {
Expand Down Expand Up @@ -811,14 +885,23 @@ private void inspectExtensions(String prefix, ExtensionContainer container) {

Object ext;
try {
ext = project.getExtensions().getByName(extName);
ext = container.getByName(extName);
if (ext == null) {
continue;
}
} catch (UnknownDomainObjectException ex) {
// ignore, the extension could not be obtained, ignore.
continue;
}

// special case for 'ext' DefaultProperiesExtension whose properties are 'merged' with the base object
// can be read in the buildscript as if the object itself defined them
if (DEFAULT_EXTENSION_NAME.equals(extName) && (ext instanceof ExtraPropertiesExtension)) {
String p = prefix.endsWith(".") ? prefix.substring(0, prefix.length() - 1) : prefix;
dumpContainerProperties(((ExtraPropertiesExtension)ext).getProperties(), p, values);
continue;
}

Class c = findNonDecoratedClass(ext.getClass());
propertyTypes.put(prefix + extName, c.getName());
inspectObjectAndValues(ext.getClass(), ext, prefix + extName + ".", globalTypes, propertyTypes, values);
Expand Down
11 changes: 7 additions & 4 deletions extide/gradle/src/org/netbeans/modules/gradle/api/BuildPropertiesSupport.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -180,10 +180,12 @@ public Iterator<Property> iterator() {
}

/**
* Returns keys of map-style properties. Works only for properties of {@link PropertyKind#MAP}.
* @param owner
* @return
* Returns keys of map-style properties. Works only for properties of {@link PropertyKind#MAP} or
* {@link PropertyKind#STRUCTURE}. May return an empty list, if keys cannot be enumerated or represented as Strings.
* @param owner the property
* @return list of keys, possibly empty. Does not return null
*/
@NonNull
public Collection<String> keys(Property owner) {
if ((owner.getKind() != PropertyKind.STRUCTURE) && (owner.getKind() != PropertyKind.MAP)) {
return Collections.emptyList();
Expand All @@ -204,8 +206,9 @@ public Collection<String> keys(Property owner) {
* @param base the map property
* @param key map item's key
* @param path optional path within an item to the property.
* @return map item, or a property of a map item.
* @return map item, or a property of a map item. Null, if the item can not be found.
*/
@CheckForNull
public Property get(Property base, String key, String path) {
if ((base.getKind() != PropertyKind.MAP)) {
return null;
Expand Down
Loading

0 comments on commit b3dca4a

Please sign in to comment.