org.netbeans.modules.gradle.nodes.ConfigurationsNode Maven / Gradle / Ivy
/*
* 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.netbeans.modules.gradle.nodes;
import org.netbeans.modules.gradle.ActionProviderImpl;
import org.netbeans.modules.gradle.loaders.GradleArtifactStore;
import org.netbeans.modules.gradle.NbGradleProjectImpl;
import org.netbeans.modules.gradle.api.GradleDependency;
import org.netbeans.modules.gradle.GradleProject;
import org.netbeans.modules.gradle.api.GradleConfiguration;
import org.netbeans.modules.gradle.api.NbGradleProject;
import org.netbeans.modules.gradle.api.execute.RunUtils;
import org.netbeans.modules.gradle.spi.GradleSettings;
import java.awt.Image;
import java.awt.event.ActionEvent;
import java.beans.PropertyChangeEvent;
import java.beans.PropertyChangeListener;
import java.io.File;
import java.io.IOException;
import java.net.URL;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.prefs.PreferenceChangeEvent;
import java.util.prefs.PreferenceChangeListener;
import javax.swing.AbstractAction;
import javax.swing.Action;
import javax.swing.event.ChangeEvent;
import javax.swing.event.ChangeListener;
import org.netbeans.api.annotations.common.StaticResource;
import org.netbeans.api.project.Project;
import org.netbeans.api.project.ProjectManager;
import org.netbeans.modules.gradle.api.GradleBaseProject;
import org.netbeans.modules.gradle.api.NbGradleProject.Quality;
import org.netbeans.spi.project.ui.LogicalViewProvider;
import org.openide.actions.PropertiesAction;
import org.openide.awt.HtmlBrowser;
import org.openide.filesystems.FileObject;
import org.openide.filesystems.FileUtil;
import org.openide.loaders.DataObject;
import org.openide.loaders.DataObjectNotFoundException;
import org.openide.nodes.AbstractNode;
import org.openide.nodes.ChildFactory;
import org.openide.nodes.Children;
import org.openide.nodes.FilterNode;
import org.openide.nodes.Node;
import org.openide.nodes.PropertySupport;
import org.openide.nodes.Sheet;
import org.openide.util.ImageUtilities;
import org.openide.util.NbBundle;
import org.openide.util.NbBundle.Messages;
import org.openide.util.actions.SystemAction;
import org.openide.util.lookup.Lookups;
/**
*
* @author Laszlo Kishalmi
*/
public class ConfigurationsNode extends AbstractNode {
private final NbGradleProjectImpl project;
private static final String REQUESTED_COMPONENT = "requestedComponent";
@StaticResource
private static final String LIBRARIES_ICON = "org/netbeans/modules/gradle/resources/libraries.png"; //NOI18N
@StaticResource
private static final String WARNING_BADGE = "org/netbeans/modules/gradle/resources/warning-badge.png"; //NOI18N
@StaticResource
private static final String SOURCES_BADGE = "org/netbeans/modules/gradle/resources/sources-badge.png"; //NOI18N
@StaticResource
private static final String JAVADOC_BADGE = "org/netbeans/modules/gradle/resources/javadoc-badge.png"; //NOI18N
@StaticResource
private static final String UNRESOLVED_ICON = "org/netbeans/modules/gradle/resources/empty.png"; //NOI18N
@StaticResource
private static final String ARTIFACT_ICON = "org/netbeans/modules/gradle/resources/module-artifact.png"; //NOI18N
private final Action downloadSourcesAction;
private final Action downloadJavadocAction;
@NbBundle.Messages({
"LBL_ConfigurationsNode=Configurations"
})
@SuppressWarnings("OverridableMethodCallInConstructor")
public ConfigurationsNode(NbGradleProjectImpl project) {
super(Children.create(new ConfigurationsChildren(project), false), Lookups.singleton(project));
this.project = project;
setName("configurations"); //NOI18N
setDisplayName(Bundle.LBL_ConfigurationsNode());
downloadSourcesAction = ActionProviderImpl.createCustomGradleAction(project, "Download Sources",
ActionProviderImpl.COMMAND_DL_SOURCES, Lookups.singleton(RunUtils.simpleReplaceTokenProvider(REQUESTED_COMPONENT, "ALL"))); //NOI18N
downloadJavadocAction = ActionProviderImpl.createCustomGradleAction(project, "Download Javadoc",
ActionProviderImpl.COMMAND_DL_JAVADOC, Lookups.singleton(RunUtils.simpleReplaceTokenProvider(REQUESTED_COMPONENT, "ALL"))); //NOI18N
}
@Override
public Image getIcon(int type) {
GradleProject gp = project.getGradleProject();
Image ret = ImageUtilities.loadImage(LIBRARIES_ICON);
if (gp.getQuality().worseThan(Quality.FULL) || needsResolve()) {
Image warn = ImageUtilities.loadImage(WARNING_BADGE);
ret = ImageUtilities.mergeImages(ret, warn, 8, 0);
}
return ret;
}
@Override
public Image getOpenedIcon(int type) {
return getIcon(type);
}
@Override
public Action[] getActions(boolean context) {
return new Action[]{
downloadSourcesAction,
downloadJavadocAction
};
}
@NbBundle.Messages({
"HINT_ConfigurationsNode=Project Configurations",
"HINT_ConfigurationsNodeUnresolved=There are unresolved configurations!"
})
@Override
public String getShortDescription() {
return !needsResolve() ? Bundle.HINT_ConfigurationsNode() : Bundle.HINT_ConfigurationsNodeUnresolved();
}
private boolean needsResolve() {
GradleBaseProject gbp = GradleBaseProject.get(project);
return !gbp.isResolved() && !gbp.hasPlugins("java-platform"); //NOI18N
}
private static class ConfigurationsChildren extends ChildFactory.Detachable implements PreferenceChangeListener, PropertyChangeListener {
private final NbGradleProjectImpl project;
public ConfigurationsChildren(NbGradleProjectImpl project) {
this.project = project;
}
@Override
protected Node createNodeForKey(GradleConfiguration conf) {
return new ConfigurationNode(project, conf);
}
@Override
protected boolean createKeys(List list) {
boolean hideEmpty = GradleSettings.getDefault().isHideEmptyConfigurations();
ArrayList ret = new ArrayList<>();
for (GradleConfiguration conf : project.getGradleProject().getBaseProject().getConfigurations().values()) {
if (!hideEmpty || !conf.isEmpty()) {
ret.add(conf);
}
}
Collections.sort(ret);
list.addAll(ret);
return true;
}
@Override
protected void removeNotify() {
NbGradleProject.removePropertyChangeListener(project, this);
GradleSettings.getDefault().getPreferences().removePreferenceChangeListener(this);
}
@Override
protected void addNotify() {
GradleSettings.getDefault().getPreferences().addPreferenceChangeListener(this);
NbGradleProject.addPropertyChangeListener(project, this);
}
@Override
public void preferenceChange(PreferenceChangeEvent evt) {
if (GradleSettings.PROP_HIDE_EMPTY_CONF.equals(evt.getKey())) {
refresh(false);
}
}
@Override
public void propertyChange(PropertyChangeEvent evt) {
refresh(false);
}
}
private static class ConfigurationChildren extends ChildFactory.Detachable implements PropertyChangeListener {
private final Project project;
private final String configuration;
public ConfigurationChildren(Project project, String configuration) {
this.project = project;
this.configuration = configuration;
}
@NbBundle.Messages({
"LBL_LocalDependenciesNode=Local Files",
"HINT_NotResolvableConfiguration=This dependency is not resolved here as its configuration can't be resolved.",})
@Override
protected Node[] createNodesForKey(GradleDependency key) {
ArrayList ret = new ArrayList<>(1);
switch (key.getType()) {
case MODULE: {
GradleDependency.ModuleDependency dep = (GradleDependency.ModuleDependency) key;
for (File artifact : dep.getArtifacts()) {
FileObject fo = FileUtil.toFileObject(artifact);
if (fo != null) {
try {
DataObject dataObject = DataObject.find(fo);
ret.add(new ModuleFilterNode(project, dep, dataObject));
} catch (DataObjectNotFoundException ex) {
// Should not happen here
}
}
}
break;
}
case PROJECT: {
GradleDependency.ProjectDependency dep = (GradleDependency.ProjectDependency) key;
//TODO: Shouldn't be done here on AWT
File projDir = dep.getPath();
FileObject fo = FileUtil.toFileObject(projDir);
if (fo != null) {
try {
Project prj = ProjectManager.getDefault().findProject(fo);
if (prj != null && prj.getLookup().lookup(NbGradleProjectImpl.class) != null) {
NbGradleProjectImpl proj = (NbGradleProjectImpl) prj;
assert prj.getLookup().lookup(LogicalViewProvider.class) != null;
Node original = proj.getLookup().lookup(LogicalViewProvider.class).createLogicalView();
ret.add(new SubProjectsNode.ProjectFilterNode(original));
}
} catch (IllegalArgumentException | IOException ex) {
ex.printStackTrace();//TODO log ?
}
} else {
//TODO broken module reference.. show as such..
}
break;
}
case FILE: {
GradleDependency.FileCollectionDependency dep = (GradleDependency.FileCollectionDependency) key;
AbstractNode node = new AbstractNode(Children.create(new FileDependencyChildren(dep), true));
node.setDisplayName(Bundle.LBL_LocalDependenciesNode());
node.setIconBaseWithExtension(LIBRARIES_ICON);
ret.add(node);
break;
}
case UNRESOLVED: {
GradleConfiguration conf = GradleBaseProject.get(project).getConfigurations().get(configuration);
GradleDependency.UnresolvedDependency dep = (GradleDependency.UnresolvedDependency) key;
AbstractNode node = new AbstractNode(Children.LEAF);
node.setName(dep.getId());
node.setIconBaseWithExtension(UNRESOLVED_ICON);
if (!conf.isCanBeResolved()) {
node.setShortDescription(Bundle.HINT_NotResolvableConfiguration());
}
ret.add(node);
break;
}
}
return ret.toArray(new Node[ret.size()]);
}
@Override
protected boolean createKeys(List list) {
ArrayList ret = new ArrayList<>();
GradleConfiguration conf = GradleBaseProject.get(project).getConfigurations().get(configuration);
// We can get null here in some extreme cases, e.g. when the project is being deleted
if (conf != null) {
ret.addAll(conf.getUnresolved());
ret.addAll(conf.getProjects());
ret.addAll(conf.getModules());
GradleDependency.FileCollectionDependency fileDeps = conf.getFiles();
if ((fileDeps != null) && !fileDeps.getFiles().isEmpty()) {
ret.add(fileDeps);
}
Collections.sort(ret);
list.addAll(ret);
}
return true;
}
@Override
protected void removeNotify() {
NbGradleProject.removePropertyChangeListener(project, this);
}
@Override
protected void addNotify() {
NbGradleProject.addPropertyChangeListener(project, this);
}
@Override
public void propertyChange(PropertyChangeEvent evt) {
refresh(false);
}
}
private static class ModuleFilterNode extends FilterNode implements ChangeListener {
private final Project project;
private final GradleDependency.ModuleDependency module;
private final DataObject mainJar;
public ModuleFilterNode(Project project, GradleDependency.ModuleDependency module, DataObject mainJar) {
super(mainJar.getNodeDelegate().cloneNode());
this.project = project;
this.module = module;
this.mainJar = mainJar;
GradleArtifactStore.getDefault().addChangeListener(this);
}
@Override
public Action[] getActions(boolean context) {
List actions = new ArrayList<>(3);
actions.add(new OpenJavadocAction(mainJar.getPrimaryFile()));
if (module.getSources().isEmpty()) {
Action download = ActionProviderImpl.createCustomGradleAction(project, "Download Sources",
ActionProviderImpl.COMMAND_DL_SOURCES, Lookups.singleton(RunUtils.simpleReplaceTokenProvider(REQUESTED_COMPONENT, module.getId())));
actions.add(download);
}
if (module.getJavadoc().isEmpty()) {
Action download = ActionProviderImpl.createCustomGradleAction(project, "Download Javadoc",
ActionProviderImpl.COMMAND_DL_JAVADOC, Lookups.singleton(RunUtils.simpleReplaceTokenProvider(REQUESTED_COMPONENT, module.getId())));
actions.add(download);
}
return actions.toArray(new Action[actions.size()]);
}
@Override
public Image getOpenedIcon(int type) {
return getIcon(type);
}
@Override
public String getShortDescription() {
StringBuilder sb = new StringBuilder("");
sb.append("Artifact Id: ").append(module.getId()).append("
");
sb.append("File: ").append(mainJar.getPrimaryFile().getPath());
return sb.toString();
}
@Override
public String getDisplayName() {
String prefix = module.getName() + "-" + module.getVersion() + "-"; //NOI18N
String mainJarName = mainJar.getPrimaryFile().getName();
String postfix = mainJarName.startsWith(prefix) ? mainJarName.substring(prefix.length()) : null;
String moduleName = module.getVersion().isEmpty() ? module.getName() : module.getName() + ":" + module.getVersion(); //NOI18N
return postfix != null ? moduleName + " [" + postfix + "]" : moduleName; //NOI18N
}
@Override
public Image getIcon(int type) {
Image ret = ImageUtilities.loadImage(ARTIFACT_ICON);
if (!module.getSources().isEmpty()) {
Image javadoc = ImageUtilities.loadImage(JAVADOC_BADGE);
ret = ImageUtilities.mergeImages(ret, javadoc, 0, 8);
}
if (!module.getJavadoc().isEmpty()) {
Image sources = ImageUtilities.loadImage(SOURCES_BADGE);
ret = ImageUtilities.mergeImages(ret, sources, 8, 8);
}
return ret;
}
@Override
public void stateChanged(ChangeEvent e) {
fireIconChange();
}
@Override
public void destroy() throws IOException {
GradleArtifactStore.getDefault().removeChangeListener(this);
super.destroy();
}
}
private static class FileDependencyChildren extends ChildFactory {
final GradleDependency.FileCollectionDependency dep;
public FileDependencyChildren(GradleDependency.FileCollectionDependency dep) {
this.dep = dep;
}
@Override
protected boolean createKeys(List keys) {
ArrayList ret = new ArrayList<>(dep.getFiles().size());
for (File file : dep.getFiles()) {
FileObject fo = FileUtil.toFileObject(file);
if (fo != null) {
ret.add(fo);
}
}
ret.sort((FileObject o1, FileObject o2) -> o1.getNameExt().compareTo(o2.getNameExt()));
keys.addAll(ret);
return true;
}
@Override
protected Node createNodeForKey(FileObject key) {
try {
DataObject dataObject = DataObject.find(key);
return new LocalFileFilterNode(key, dataObject.getNodeDelegate().cloneNode());
} catch (DataObjectNotFoundException ex) {
// Should not happen here
}
return null;
}
}
private static class ConfigurationNode extends AbstractNode {
public ConfigurationNode(Project project, GradleConfiguration conf) {
super(conf.isEmpty() ? Children.LEAF : Children.create(new ConfigurationChildren(project, conf.getName()), false), Lookups.fixed(project, conf));
setName(conf.getName());
setShortDescription(conf.getDescription());
StringBuilder displayName = new StringBuilder(conf.getName());
if (!conf.getExtendsFrom().isEmpty()) {
displayName.append(" [").append(extendsFrom(conf)).append(']');
}
setDisplayName(displayName.toString());
setIconBaseWithExtension(LIBRARIES_ICON);
}
@Override
@Messages({
"LBL_name=Name",
"LBL_canBeConsumed=Can be Consumed",
"LBL_canBeResolved=Can be Resolved",
"LBL_extendsFrom=Extends From",
"LBL_transitive=Transitive",
"LBL_attributes=Attributes",
})
protected final Sheet createSheet() {
Sheet sheet = Sheet.createDefault();
Sheet.Set set = Sheet.createPropertiesSet();
GradleConfiguration conf = getLookup().lookup(GradleConfiguration.class);
set.put(PropertySupport.readOnly("name", String.class, conf::getName).withDisplayName(Bundle.LBL_name())); //NOI18N
set.put(PropertySupport.readOnly("canBeConsumed", Boolean.class, conf::isCanBeConsumed).withDisplayName(Bundle.LBL_canBeConsumed())); //NOI18N
set.put(PropertySupport.readOnly("canBeResolved", Boolean.class, conf::isCanBeResolved).withDisplayName(Bundle.LBL_canBeResolved())); //NOI18N
set.put(PropertySupport.readOnly("extendsFrom", String.class, () -> extendsFrom(conf)).withDisplayName(Bundle.LBL_extendsFrom())); //NOI18N
set.put(PropertySupport.readOnly("transitive", Boolean.class, conf::isTransitive).withDisplayName(Bundle.LBL_transitive())); //NOI18N
sheet.put(set);
Sheet.Set attrs = new Sheet.Set();
attrs.setName("attributes"); //NOI18N
attrs.setDisplayName(Bundle.LBL_attributes());
for (Map.Entry entry : conf.getAttributes().entrySet()) {
attrs.put(PropertySupport.readOnly(entry.getKey(), String.class, entry::getValue));
}
sheet.put(attrs);
return sheet;
}
@Override
public Action[] getActions(boolean context) {
return new Action[] {
SystemAction.get(PropertiesAction.class),
};
}
}
private static class LocalFileFilterNode extends FilterNode {
private final FileObject mainJar;
public LocalFileFilterNode(FileObject mainJar, Node original) {
super(original);
this.mainJar = mainJar;
}
@Override
public Action[] getActions(boolean context) {
List actions = new ArrayList<>(3);
actions.add(new OpenJavadocAction(mainJar));
return actions.toArray(new Action[actions.size()]);
}
@Override
public Image getOpenedIcon(int type) {
return getIcon(type);
}
@Override
public String getShortDescription() {
return mainJar.getPath();
}
@Override
public Image getIcon(int type) {
GradleArtifactStore store = GradleArtifactStore.getDefault();
Image ret = super.getIcon(type);
if (store.getJavadoc(FileUtil.toFile(mainJar)) != null) {
Image javadoc = ImageUtilities.loadImage(JAVADOC_BADGE);
ret = ImageUtilities.mergeImages(ret, javadoc, 0, 8);
}
if (store.getSources(FileUtil.toFile(mainJar)) != null) {
Image sources = ImageUtilities.loadImage(SOURCES_BADGE);
ret = ImageUtilities.mergeImages(ret, sources, 8, 8);
}
return ret;
}
}
private static class OpenJavadocAction extends AbstractAction {
private final FileObject mainJar;
@NbBundle.Messages({
"LBL_OpenJavadocAction=Show Javadoc"
})
public OpenJavadocAction(FileObject mainJar) {
super(Bundle.LBL_OpenJavadocAction());
this.mainJar = mainJar;
}
@Override
public void actionPerformed(ActionEvent e) {
File javadoc = GradleArtifactStore.getDefault().getJavadoc(FileUtil.toFile(mainJar));
FileObject fo = FileUtil.toFileObject(javadoc);
if (fo != null) {
FileObject arch = FileUtil.getArchiveRoot(fo);
if (arch != null) {
FileObject index = arch.getFileObject("index.html"); //NOI18N
if (index != null) {
URL indexUrl = index.toURL();
HtmlBrowser.URLDisplayer.getDefault().showURL(indexUrl);
}
}
}
}
@Override
public boolean isEnabled() {
File javadoc = GradleArtifactStore.getDefault().getJavadoc(FileUtil.toFile(mainJar));
return javadoc != null;
}
}
private static String extendsFrom(GradleConfiguration conf) {
StringBuilder ret = new StringBuilder();
String separator = "";
for (GradleConfiguration ext : conf.getExtendsFrom()) {
ret.append(separator);
ret.append(ext.getName());
separator = ", ";
}
return ret.toString();
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy