org.netbeans.modules.maven.nodes.DependenciesNode Maven / Gradle / Ivy
The newest version!
/*
* 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.maven.nodes;
import org.netbeans.modules.maven.DependencyType;
import org.netbeans.modules.maven.ModuleInfoSupport;
import java.awt.Image;
import java.awt.event.ActionEvent;
import java.beans.PropertyChangeEvent;
import java.beans.PropertyChangeListener;
import java.net.URL;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.Comparator;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.Set;
import java.util.concurrent.atomic.AtomicBoolean;
import java.util.function.Function;
import java.util.function.Supplier;
import java.util.logging.Level;
import java.util.logging.Logger;
import java.util.prefs.Preferences;
import javax.swing.AbstractAction;
import javax.swing.Action;
import javax.swing.Icon;
import javax.swing.UIManager;
import javax.swing.event.ChangeEvent;
import javax.swing.event.ChangeListener;
import org.apache.maven.artifact.Artifact;
import org.apache.maven.project.MavenProject;
import org.netbeans.api.annotations.common.StaticResource;
import org.netbeans.api.java.source.SourceUtils;
import org.netbeans.api.progress.aggregate.AggregateProgressHandle;
import org.netbeans.api.progress.aggregate.BasicAggregateProgressFactory;
import org.netbeans.api.progress.aggregate.ProgressContributor;
import org.netbeans.api.project.Project;
import org.netbeans.modules.maven.NbMavenProjectImpl;
import org.netbeans.modules.maven.api.ModelUtils;
import org.netbeans.modules.maven.api.NbMavenProject;
import org.netbeans.modules.maven.embedder.exec.ProgressTransferListener;
import static org.netbeans.modules.maven.nodes.Bundle.*;
import org.openide.filesystems.FileObject;
import org.openide.filesystems.FileUtil;
import org.openide.nodes.AbstractNode;
import org.openide.nodes.ChildFactory;
import org.openide.nodes.Children;
import org.openide.nodes.Node;
import org.openide.util.ChangeSupport;
import org.openide.util.ImageUtilities;
import org.openide.util.NbBundle.Messages;
import org.openide.util.NbPreferences;
import org.openide.util.RequestProcessor;
import org.openide.util.Utilities;
import org.openide.util.WeakListeners;
import org.openide.util.lookup.Lookups;
/**
* root node for dependencies in project's view.
* @author Milos Kleint
*/
public class DependenciesNode extends AbstractNode {
private static final Logger LOG = Logger.getLogger(DependenciesNode.class.getName());
public static final String PREF_DEPENDENCIES_UI = "org/netbeans/modules/maven/dependencies/ui"; //NOI18N
private static final @StaticResource String LIBS_BADGE = "org/netbeans/modules/maven/libraries-badge.png";
private static final @StaticResource String DEF_FOLDER = "org/netbeans/modules/maven/defaultFolder.gif";
private final DependenciesSet dependencies;
@Messages({
"LBL_Libraries=Dependencies",
"LBL_Test_Libraries=Test Dependencies",
"LBL_Runtime_Libraries=Runtime Dependencies",
"LBL_non_cp_libraries=Non-classpath Dependencies"
})
DependenciesNode(DependenciesSet dependencies) {
super(Children.create(new DependenciesChildren(dependencies), true), Lookups.fixed(dependencies.project, PathFinders.createPathFinder()));
this.dependencies = dependencies;
setName("Dependencies" + dependencies.type); //NOI18N
switch (dependencies.type) {
case COMPILE : setDisplayName(LBL_Libraries()); break;
case TEST : setDisplayName(LBL_Test_Libraries()); break;
case RUNTIME : setDisplayName(LBL_Runtime_Libraries()); break;
default : setDisplayName(LBL_non_cp_libraries()); break;
}
setIconBaseWithExtension(DEF_FOLDER); //NOI18N
}
@Override
public Image getIcon(int param) {
Image retValue = ImageUtilities.mergeImages(getTreeFolderIcon(false),
ImageUtilities.loadImage(LIBS_BADGE), //NOI18N
8, 8);
return retValue;
}
@Override
public Image getOpenedIcon(int param) {
Image retValue = ImageUtilities.mergeImages(getTreeFolderIcon(true),
ImageUtilities.loadImage(LIBS_BADGE), //NOI18N
8, 8);
return retValue;
}
@Override
public Action[] getActions(boolean context) {
ArrayList toRet = new ArrayList();
toRet.add(new AddDependencyAction());
toRet.add(null);
toRet.add(new ResolveDepsAction(dependencies.project));
toRet.add(new DownloadJavadocSrcAction(true));
toRet.add(new DownloadJavadocSrcAction(false));
toRet.addAll(Utilities.actionsForPath("Projects/org-netbeans-modules-maven/DependenciesActions")); //NOI18N
toRet.add(null);
toRet.add(new DependencyNode.ShowManagedStateAction());
return toRet.toArray(new Action[0]);
}
private static class DependenciesChildren extends ChildFactory implements ChangeListener {
private final DependenciesSet dependencies;
@SuppressWarnings("LeakingThisInConstructor")
DependenciesChildren(DependenciesSet dependencies) {
this.dependencies = dependencies;
dependencies.addChangeListener(WeakListeners.change(this, dependencies));
}
@Override
protected Node createNodeForKey(DependencyWrapper wr) {
return new DependencyNode(dependencies.project, wr.getArtifact(), wr.getFileObject(), true, wr.getNodeDelegate(), wr.isDeclaredInModuleInfo());
}
@Override public void stateChanged(ChangeEvent e) {
refresh(false);
}
@Override protected boolean createKeys(List toPopulate) {
toPopulate.addAll(dependencies.list(true));
return true;
}
}
static final class DependenciesSet implements PropertyChangeListener {
private NbMavenProjectImpl project;
private final DependencyType type;
private final ChangeSupport cs = new ChangeSupport(this);
private final ModuleInfoSupport moduleInfoSupport;
@SuppressWarnings("LeakingThisInConstructor")
DependenciesSet(NbMavenProjectImpl project, DependencyType type) {
this.project = project;
this.type = type;
ModuleInfoSupport mis = null;
switch (type) {
case COMPILE:
case TEST:
try {
mis = new ModuleInfoSupport(project, type);
break;
} catch (LinkageError err) {
LOG.log(Level.INFO, "Can't initialize dependencies", err);
// fallthrough
}
default:
}
this.moduleInfoSupport = mis;
NbMavenProject nbmp = project.getProjectWatcher();
nbmp.addPropertyChangeListener(WeakListeners.propertyChange(this, nbmp));
}
Collection list(boolean longLiving) {
HashSet lst;
MavenProject mp = project.getOriginalMavenProject();
Set arts = mp.getArtifacts();
switch (type) {
case COMPILE:
case TEST:
case RUNTIME:
lst = create(arts, longLiving, type.artifactScopes());
break;
default:
lst = create(arts, longLiving, (a) -> !a.getArtifactHandler().isAddedToClasspath());
}
//#200927 do not use comparator in treeset, comparator not equivalent to equals/hashcode
ArrayList l = new ArrayList<>(lst);
l.sort(new DependenciesComparator());
return l;
}
public void addChangeListener(ChangeListener listener) {
cs.addChangeListener(listener);
}
public void removeChangeListener(ChangeListener listener) {
cs.addChangeListener(listener);
}
@Override public void propertyChange(PropertyChangeEvent evt) {
if (NbMavenProject.PROP_PROJECT.equals(evt.getPropertyName())) {
cs.fireChange();
}
}
private HashSet create(Set arts, boolean longLiving, List scopesList) {
return create(arts, longLiving, (a) -> a.getArtifactHandler().isAddedToClasspath() && scopesList.contains(a.getScope()));
}
private HashSet create(Set arts, boolean longLiving, Function accept) {
HashSet lst = new HashSet<>();
for (Artifact a : arts) {
if (accept.apply(a)) {
URL url = FileUtil.urlForArchiveOrDir(a.getFile());
String name = url != null ? SourceUtils.getModuleName(url) : null;
if(name != null) {
LOG.log(Level.FINE, "Artifact {0} has module name ''{1}''", new Object[]{url, name}); // NOI18N
lst.add(new DependencyWrapper(a, longLiving, () -> moduleInfoSupport != null ? moduleInfoSupport.canAddToModuleInfo(name) : false));
} else {
LOG.log(Level.WARNING, "Could not determine module name for artifact {0}", new Object[]{url}); // NOI18N
lst.add(new DependencyWrapper(a, longLiving, () -> false));
}
}
}
return lst;
}
}
private static final class DependencyWrapper {
private final Artifact artifact;
private final FileObject fileObject;
private final Node nodeDelegate;
private final String artifactString;
private final String depenencyTrailString;
private final String filePath;
private final int dependencyTrailSize;
private final String artifactId;
private final Supplier canAddToModuleInfo;
public DependencyWrapper(Artifact artifact, boolean longLiving, Supplier canAddToModuleInfo) {
this.artifact = artifact;
assert artifact.getFile() != null : "#200927 Artifact.getFile() is null: " + artifact;
assert artifact.getDependencyTrail() != null : "#200927 Artifact.getDependencyTrail() is null:" + artifact;
assert artifact.getVersion() != null : "200927 Artifact.getVersion() is null: " + artifact;
this.canAddToModuleInfo = canAddToModuleInfo;
// artifact is mutable and might be the source of issues like in #250473
// lets fix the values necessary for an imutable hasCode, equals
// and compare computation. The Dependency nodes seem to get recreated
// on relevant changes anyway ...
artifactId = artifact.getArtifactId();
artifactString = artifact.toString();
StringBuilder sb = new StringBuilder();
List dependencyTrail = new ArrayList<>(artifact.getDependencyTrail());
Collections.sort(dependencyTrail);
dependencyTrailSize = dependencyTrail.size();
Iterator it = dependencyTrail.iterator();
while(it.hasNext()) {
sb.append(it.next());
if(it.hasNext()) {
sb.append(";"); // NOI18N
}
}
depenencyTrailString = sb.toString();
filePath = artifact.getFile().getAbsolutePath();
fileObject = FileUtil.toFileObject(artifact.getFile());
nodeDelegate = DependencyNode.createNodeDelegate(artifact, fileObject, longLiving);
}
public FileObject getFileObject() {
return fileObject;
}
public Node getNodeDelegate() {
return nodeDelegate;
}
public Artifact getArtifact() {
return artifact;
}
public Supplier isDeclaredInModuleInfo() {
return canAddToModuleInfo;
}
@Override
public boolean equals(Object obj) {
if (obj == null) {
return false;
}
if (getClass() != obj.getClass()) {
return false;
}
final DependencyWrapper other = (DependencyWrapper) obj;
if (!artifactString.equals(other.artifactString)) {
return false;
}
if (!depenencyTrailString.equals(other.depenencyTrailString)) {
return false;
}
if (!filePath.equals(other.filePath)) {
return false;
}
return true;
}
@Override
public int hashCode() {
int hash = 7;
hash = 31 * hash + artifactString.hashCode();
hash = 31 * hash + depenencyTrailString.hashCode();
hash = 31 * hash + filePath.hashCode();
return hash;
}
private int getDependencyTrailSize() {
return dependencyTrailSize;
}
private String getArtifactId() {
return artifactId;
}
private String getArtifactString() {
return artifactString;
}
}
@SuppressWarnings("serial")
private class AddDependencyAction extends AbstractAction {
@Messages("BTN_Add_Library=Add Dependency...")
AddDependencyAction() {
putValue(Action.NAME, BTN_Add_Library());
}
@Override public void actionPerformed(ActionEvent event) {
String typeString = dependencies.type == DependencyType.RUNTIME ? "runtime" : (dependencies.type == DependencyType.TEST ? "test" : "compile"); //NOI18N
final String[] data = AddDependencyPanel.show(dependencies.project, true, typeString);
if (data != null) {
RP.post(new Runnable() {
@Override
public void run() {
ModelUtils.addDependency(dependencies.project.getProjectDirectory().getFileObject("pom.xml")/*NOI18N*/,
data[0], data[1], data[2], data[4], data[3], data[5], false);
dependencies.project.getLookup().lookup(NbMavenProject.class).downloadDependencyAndJavadocSource(false);
}
});
}
}
}
private static final RequestProcessor RP = new RequestProcessor(DependenciesNode.class);
@SuppressWarnings("serial")
private class DownloadJavadocSrcAction extends AbstractAction {
private boolean javadoc;
@Messages({
"LBL_Download_Javadoc=Download Javadoc",
"LBL_Download__Sources=Download Sources"
})
DownloadJavadocSrcAction(boolean javadoc) {
putValue(Action.NAME, javadoc ? LBL_Download_Javadoc() : LBL_Download__Sources());
this.javadoc = javadoc;
}
@Messages({
"Progress_Javadoc=Downloading Javadoc",
"Progress_Source=Downloading Sources"
})
@Override public void actionPerformed(ActionEvent evnt) {
RP.post(new Runnable() {
@Override
public void run() {
Node[] nds = getChildren().getNodes(true);
ProgressContributor[] contribs = new ProgressContributor[nds.length];
for (int i = 0; i < nds.length; i++) {
contribs[i] = BasicAggregateProgressFactory.createProgressContributor("multi-" + i); //NOI18N
}
String label = javadoc ? Progress_Javadoc() : Progress_Source();
AggregateProgressHandle handle = BasicAggregateProgressFactory.createHandle(label,
contribs, ProgressTransferListener.cancellable(), null);
handle.start();
try {
ProgressTransferListener.setAggregateHandle(handle);
for (int i = 0; i < nds.length; i++) {
AtomicBoolean cancel = ProgressTransferListener.activeListener().cancel;
if (cancel != null && cancel.get()) {
return;
}
if (nds[i] instanceof DependencyNode) {
DependencyNode nd = (DependencyNode)nds[i];
if (javadoc && !nd.data.hasJavadocInRepository()) {
nd.downloadJavadocSources(contribs[i], javadoc);
} else if (!javadoc && !nd.data.hasSourceInRepository()) {
nd.downloadJavadocSources(contribs[i], javadoc);
} else {
contribs[i].finish();
}
}
}
} catch (ThreadDeath d) { // download interrupted
} catch (IllegalStateException ise) { //download interrupted in dependent thread. #213812
if (!(ise.getCause() instanceof ThreadDeath)) {
throw ise;
}
} finally {
handle.finish();
ProgressTransferListener.clearAggregateHandle();
}
}
});
}
}
@SuppressWarnings("serial")
private static class ResolveDepsAction extends AbstractAction {
private final Project project;
@Messages("LBL_Download=Download Declared Dependencies")
ResolveDepsAction(Project prj) {
putValue(Action.NAME, LBL_Download());
project = prj;
}
@Override
public void actionPerformed(ActionEvent evnt) {
setEnabled(false);
project.getLookup().lookup(NbMavenProject.class).downloadDependencyAndJavadocSource(false);
}
}
private static class DependenciesComparator implements Comparator {
@Override
public int compare(DependencyWrapper art1, DependencyWrapper art2) {
boolean transitive1 = art1.getDependencyTrailSize() > 2;
boolean transitive2 = art2.getDependencyTrailSize() > 2;
if (transitive1 && !transitive2) {
return 1;
}
if (!transitive1 && transitive2) {
return -1;
}
int ret = art1.getArtifactId().compareTo(art2.getArtifactId());
if (ret != 0) {
return ret;
}
return art1.getArtifactString().compareTo(art2.getArtifactString());
}
}
private static final String ICON_KEY_UIMANAGER = "Tree.closedIcon"; // NOI18N
private static final String OPENED_ICON_KEY_UIMANAGER = "Tree.openIcon"; // NOI18N
private static final String ICON_KEY_UIMANAGER_NB = "Nb.Explorer.Folder.icon"; // NOI18N
private static final String OPENED_ICON_KEY_UIMANAGER_NB = "Nb.Explorer.Folder.openedIcon"; // NOI18N
private static final String ICON_PATH = DEF_FOLDER; // NOI18N
private static final @StaticResource String OPENED_ICON_PATH = "org/netbeans/modules/maven/defaultFolderOpen.gif"; // NOI18N
/**
* Returns default folder icon as {@link java.awt.Image}. Never returns
* null.
*
* @param opened wheter closed or opened icon should be returned.
*
* copied from apisupport/project
*/
public static Image getTreeFolderIcon(boolean opened) {
Image base;
Icon baseIcon = UIManager.getIcon(opened ? OPENED_ICON_KEY_UIMANAGER : ICON_KEY_UIMANAGER); // #70263
if (baseIcon != null) {
base = ImageUtilities.icon2Image(baseIcon);
} else {
base = (Image) UIManager.get(opened ? OPENED_ICON_KEY_UIMANAGER_NB : ICON_KEY_UIMANAGER_NB); // #70263
if (base == null) { // fallback to our owns
base = ImageUtilities.loadImage(opened ? OPENED_ICON_PATH : ICON_PATH, true);
}
}
assert base != null;
return base;
}
static Preferences prefs() {
return NbPreferences.root().node(PREF_DEPENDENCIES_UI);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy