blob: 7b0f02381b782aa441210d826a17a00893a2400d [file] [log] [blame]
/*******************************************************************************
* Copyright (c) 2000, 2018 IBM Corporation and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.jdt.internal.ui.wizards.buildpaths;
import java.lang.reflect.InvocationTargetException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.stream.Collectors;
import org.eclipse.swt.graphics.Image;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.Path;
import org.eclipse.core.resources.IMarker;
import org.eclipse.core.resources.IProject;
import org.eclipse.jface.operation.IRunnableContext;
import org.eclipse.ui.IMarkerResolution;
import org.eclipse.ui.IMarkerResolution2;
import org.eclipse.ui.IMarkerResolutionGenerator2;
import org.eclipse.ui.IMarkerResolutionRelevance;
import org.eclipse.ui.PlatformUI;
import org.eclipse.ui.dialogs.PreferencesUtil;
import org.eclipse.jdt.core.CorrectionEngine;
import org.eclipse.jdt.core.IClasspathEntry;
import org.eclipse.jdt.core.IJavaModelMarker;
import org.eclipse.jdt.core.IJavaModelStatusConstants;
import org.eclipse.jdt.core.IJavaProject;
import org.eclipse.jdt.core.JavaCore;
import org.eclipse.jdt.core.JavaModelException;
import org.eclipse.jdt.internal.corext.util.Messages;
import org.eclipse.jdt.ui.wizards.BuildPathDialogAccess;
import org.eclipse.jdt.internal.ui.JavaPlugin;
import org.eclipse.jdt.internal.ui.JavaPluginImages;
import org.eclipse.jdt.internal.ui.preferences.BuildPathsPropertyPage;
import org.eclipse.jdt.internal.ui.preferences.UserLibraryPreferencePage;
import org.eclipse.jdt.internal.ui.text.correction.CorrectionMessages;
import org.eclipse.jdt.internal.ui.text.java.hover.ConfigureProblemSeverityAction;
import org.eclipse.jdt.internal.ui.text.java.hover.ConfigureProblemSeverityAction.PreferencePage;
import org.eclipse.jdt.internal.ui.util.ExceptionHandler;
import org.eclipse.jdt.internal.core.manipulation.util.BasicElementLabels;
import org.eclipse.jdt.internal.ui.wizards.NewWizardMessages;
public class BuildpathProblemMarkerResolutionGenerator implements IMarkerResolutionGenerator2 {
private final static IMarkerResolution[] NO_RESOLUTION = new IMarkerResolution[0];
@Override
public boolean hasResolutions(IMarker marker) {
int id= marker.getAttribute(IJavaModelMarker.ID, -1);
if (id == IJavaModelStatusConstants.CP_CONTAINER_PATH_UNBOUND
|| id == IJavaModelStatusConstants.CP_VARIABLE_PATH_UNBOUND
|| id == IJavaModelStatusConstants.INVALID_CP_CONTAINER_ENTRY
|| id == IJavaModelStatusConstants.DEPRECATED_VARIABLE
|| id == IJavaModelStatusConstants.MAIN_ONLY_PROJECT_DEPENDS_ON_TEST_ONLY_PROJECT
|| id == IJavaModelStatusConstants.INVALID_CLASSPATH) {
return true;
}
if(JavaCore.getOptionForConfigurableBuildPathProblemSeverity(id) != null) {
return true;
}
return false;
}
@Override
public IMarkerResolution[] getResolutions(IMarker marker) {
final Shell shell= JavaPlugin.getActiveWorkbenchShell();
if (!hasResolutions(marker) || shell == null) {
return NO_RESOLUTION;
}
ArrayList<IMarkerResolution2> resolutions= new ArrayList<>();
final IJavaProject project= getJavaProject(marker);
int id= marker.getAttribute(IJavaModelMarker.ID, -1);
if (id == IJavaModelStatusConstants.CP_CONTAINER_PATH_UNBOUND) {
String[] arguments= CorrectionEngine.getProblemArguments(marker);
final IPath path= new Path(arguments[0]);
if (JavaCore.USER_LIBRARY_CONTAINER_ID.equals(path.segment(0))) {
String label= NewWizardMessages.UserLibraryMarkerResolutionGenerator_changetouserlib_label;
Image image= JavaPluginImages.get(JavaPluginImages.IMG_CORRECTION_CHANGE);
resolutions.add(new UserLibraryMarkerResolution(label, image) {
@Override
public void run(IMarker m) {
changeToExistingLibrary(shell, path, false, project);
}
});
if (path.segmentCount() == 2) {
String label2= Messages.format(NewWizardMessages.UserLibraryMarkerResolutionGenerator_createuserlib_label, path.segment(1));
Image image2= JavaPluginImages.get(JavaPluginImages.IMG_OBJS_LIBRARY);
resolutions.add(new UserLibraryMarkerResolution(label2, image2) {
@Override
public void run(IMarker m) {
createUserLibrary(shell, path);
}
});
}
}
String label= NewWizardMessages.UserLibraryMarkerResolutionGenerator_changetoother;
Image image= JavaPluginImages.get(JavaPluginImages.IMG_CORRECTION_CHANGE);
resolutions.add(new UserLibraryMarkerResolution(label, image) {
@Override
public void run(IMarker m) {
changeToExistingLibrary(shell, path, true, project);
}
});
}
String optionId= JavaCore.getOptionForConfigurableBuildPathProblemSeverity(id);
if (optionId != null) {
resolutions.add(new ConfigureSeverityResolution(project, optionId));
}
if (project != null) {
try {
// add proposal only if there are at least one required closed project
IProject[] referencedProjects= marker.getResource().getProject().getReferencedProjects();
for (IProject iProject : referencedProjects) {
if (!iProject.isOpen()) {
resolutions.add(new OpenRequiredProjectMarkerResolution(marker));
break;
}
}
} catch (CoreException e) {
ExceptionHandler.handle(e, "Open project", "Failed to open project " + project.getElementName()); //$NON-NLS-1$ //$NON-NLS-2$
}
resolutions.add(new OpenBuildPathMarkerResolution(project));
}
return resolutions.toArray(new IMarkerResolution[resolutions.size()]);
}
protected void changeToExistingLibrary(Shell shell, IPath path, boolean isNew, final IJavaProject project) {
try {
IClasspathEntry[] entries= project.getRawClasspath();
int idx= indexOfClasspath(entries, path);
if (idx == -1) {
return;
}
IClasspathEntry[] res;
if (isNew) {
res= BuildPathDialogAccess.chooseContainerEntries(shell, project, entries);
if (res == null) {
return;
}
} else {
IClasspathEntry resEntry= BuildPathDialogAccess.configureContainerEntry(shell, entries[idx], project, entries);
if (resEntry == null) {
return;
}
res= new IClasspathEntry[] { resEntry };
}
final IClasspathEntry[] newEntries= new IClasspathEntry[entries.length - 1 + res.length];
System.arraycopy(entries, 0, newEntries, 0, idx);
System.arraycopy(res, 0, newEntries, idx, res.length);
System.arraycopy(entries, idx + 1, newEntries, idx + res.length, entries.length - idx - 1);
IRunnableContext context= JavaPlugin.getActiveWorkbenchWindow();
if (context == null) {
context= PlatformUI.getWorkbench().getProgressService();
}
context.run(true, true, monitor -> {
try {
project.setRawClasspath(newEntries, project.getOutputLocation(), monitor);
} catch (CoreException e) {
throw new InvocationTargetException(e);
}
});
} catch (JavaModelException e) {
String title= NewWizardMessages.UserLibraryMarkerResolutionGenerator_error_title;
String message= NewWizardMessages.UserLibraryMarkerResolutionGenerator_error_creationfailed_message;
ExceptionHandler.handle(e, shell, title, message);
} catch (InvocationTargetException e) {
String title= NewWizardMessages.UserLibraryMarkerResolutionGenerator_error_title;
String message= NewWizardMessages.UserLibraryMarkerResolutionGenerator_error_applyingfailed_message;
ExceptionHandler.handle(e, shell, title, message);
} catch (InterruptedException e) {
// user cancelled
}
}
private int indexOfClasspath(IClasspathEntry[] entries, IPath path) {
for (int i= 0; i < entries.length; i++) {
IClasspathEntry curr= entries[i];
if (curr.getEntryKind() == IClasspathEntry.CPE_CONTAINER && curr.getPath().equals(path)) {
return i;
}
}
return -1;
}
protected void createUserLibrary(final Shell shell, IPath unboundPath) {
String name= unboundPath.segment(1);
String id= UserLibraryPreferencePage.ID;
HashMap<String, Object> data= new HashMap<>(3);
data.put(UserLibraryPreferencePage.DATA_LIBRARY_TO_SELECT, name);
data.put(UserLibraryPreferencePage.DATA_DO_CREATE, Boolean.TRUE);
PreferencesUtil.createPreferenceDialogOn(shell, id, new String[] { id }, data).open();
}
private IJavaProject getJavaProject(IMarker marker) {
return JavaCore.create(marker.getResource().getProject());
}
/**
* Library quick fix base class
*/
private static abstract class UserLibraryMarkerResolution implements IMarkerResolution2 {
private final String fLabel;
private final Image fImage;
public UserLibraryMarkerResolution(String label, Image image) {
fLabel= label;
fImage= image;
}
@Override
public String getLabel() {
return fLabel;
}
@Override
public String getDescription() {
return null;
}
@Override
public Image getImage() {
return fImage;
}
}
private static class ConfigureSeverityResolution implements IMarkerResolution2, IMarkerResolutionRelevance {
private final IJavaProject fProject;
private String fOptionId;
public ConfigureSeverityResolution(IJavaProject project, String optionId) {
fProject= project;
fOptionId= optionId;
}
@Override
public String getDescription() {
return null;
}
@Override
public Image getImage() {
return JavaPluginImages.get(JavaPluginImages.IMG_CONFIGURE_PROBLEM_SEVERITIES);
}
@Override
public String getLabel() {
return CorrectionMessages.ConfigureProblemSeveritySubProcessor_name;
}
@Override
public int getRelevanceForResolution() {
return -1;
}
@Override
public void run(IMarker marker) {
ConfigureProblemSeverityAction problemSeverityAction= new ConfigureProblemSeverityAction(fProject, fOptionId, JavaCore.PLUGIN_ID,
PreferencePage.BUILDING, null);
problemSeverityAction.run();
}
}
private static class OpenBuildPathMarkerResolution implements IMarkerResolution2 {
private final IJavaProject fProject;
public OpenBuildPathMarkerResolution(IJavaProject project) {
fProject= project;
}
@Override
public String getDescription() {
return Messages.format(CorrectionMessages.ReorgCorrectionsSubProcessor_configure_buildpath_description, BasicElementLabels.getResourceName(fProject.getElementName()));
}
@Override
public Image getImage() {
return JavaPluginImages.get(JavaPluginImages.IMG_OBJS_ACCESSRULES_ATTRIB);
}
@Override
public String getLabel() {
return CorrectionMessages.ReorgCorrectionsSubProcessor_configure_buildpath_label;
}
@Override
public void run(IMarker marker) {
PreferencesUtil.createPropertyDialogOn(JavaPlugin.getActiveWorkbenchShell(), fProject, BuildPathsPropertyPage.PROP_ID, null, null).open();
}
}
private static class OpenRequiredProjectMarkerResolution implements IMarkerResolution2, IMarkerResolutionRelevance {
private final ArrayList<IProject> closedProjects= new ArrayList<>();
public OpenRequiredProjectMarkerResolution(IMarker marker) {
try {
// collect required closed projects
IProject[] referencedProjects= marker.getResource().getProject().getReferencedProjects();
for (IProject iProject : referencedProjects) {
if (!iProject.isOpen()) {
closedProjects.add(iProject);
}
}
} catch (CoreException e) {
ExceptionHandler.handle(e, "Open project", "Failed to parse projects"); //$NON-NLS-1$ //$NON-NLS-2$
}
}
@Override
public String getDescription() {
return "Open project"; //$NON-NLS-1$
}
@Override
public Image getImage() {
return JavaPluginImages.get(JavaPluginImages.IMG_OBJS_ACCESSRULES_ATTRIB);
}
@Override
public String getLabel() {
String projects = closedProjects.stream().map(IProject::getName).collect(Collectors.joining("', '")); //$NON-NLS-1$
if(closedProjects.size() > 1) {
return Messages.format(CorrectionMessages.ReorgCorrectionsSubProcessor_open_required_projects_description, projects);
}
return Messages.format(CorrectionMessages.ReorgCorrectionsSubProcessor_open_required_project_description, projects);
}
@Override
public int getRelevanceForResolution() {
return 1;
}
@Override
public void run(IMarker marker) {
try {
for (IProject iProject : closedProjects) {
if (!iProject.isOpen()) {
iProject.open(null);
}
}
} catch (CoreException e) {
ExceptionHandler.handle(e, "Open project", "Failed to open project " + closedProjects.get(0).getName()); //$NON-NLS-1$ //$NON-NLS-2$
}
}
}
}