blob: 6b321e52291f7a9c781da88887973890cc4ef417 [file] [log] [blame]
/*******************************************************************************
* Copyright (c) 2005, 2021 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
* Gary Duprex <Gary.Duprex@aspectstools.com> - bug 150225
* Bartosz Michalik <bartosz.michalik@gmail.com> - bug 214156
* Benjamin Cabe <benjamin.cabe@anyware-tech.com> - bug 219513
*******************************************************************************/
package org.eclipse.pde.internal.ui.correction;
import java.util.ArrayList;
import java.util.Arrays;
import org.eclipse.core.resources.IMarker;
import org.eclipse.core.resources.IResource;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.pde.core.plugin.IPluginModelBase;
import org.eclipse.pde.internal.core.*;
import org.eclipse.pde.internal.core.builders.PDEMarkerFactory;
import org.eclipse.pde.internal.ui.PDEUIMessages;
import org.eclipse.ui.*;
import org.osgi.framework.Constants;
public class ResolutionGenerator implements IMarkerResolutionGenerator2 {
private static IMarkerResolution[] NO_RESOLUTIONS = new IMarkerResolution[0];
@Override
public IMarkerResolution[] getResolutions(IMarker marker) {
IMarkerResolution[] res = getNonConfigSevResolutions(marker);
String str = marker.getAttribute(PDEMarkerFactory.compilerKey, ""); //$NON-NLS-1$
if (str.length() > 0) {
ArrayList<IMarkerResolution> list = new ArrayList<>(Arrays.asList(res));
list.add(new ConfigureProblemSeverityForPDECompilerResolution(marker, AbstractPDEMarkerResolution.CONFIGURE_TYPE,
str));
return list.toArray(new IMarkerResolution[] {});
}
return res;
}
public IMarkerResolution[] getNonConfigSevResolutions(IMarker marker) {
int problemID = getProblemId(marker);
switch (problemID) {
case PDEMarkerFactory.M_DEPRECATED_AUTOSTART :
// if targetVersion <= 3.3, we can add Eclipse-LazyStart header even if previous header's value was false. We can't do this for 3.4+ since Bundle-AcativationPolicy does not have a "false" value.
if (marker.getAttribute(PDEMarkerFactory.ATTR_CAN_ADD, true) || TargetPlatformHelper.getTargetVersion() <= 3.3)
return new IMarkerResolution[] {new UpdateActivationResolution(AbstractPDEMarkerResolution.RENAME_TYPE,marker), new AddActivationHeaderResolution(AbstractPDEMarkerResolution.CREATE_TYPE, marker)};
return new IMarkerResolution[] {new UpdateActivationResolution(AbstractPDEMarkerResolution.RENAME_TYPE, marker)};
case PDEMarkerFactory.M_JAVA_PACKAGE__PORTED :
return new IMarkerResolution[] {new CreateJREBundleHeaderResolution(AbstractPDEMarkerResolution.CREATE_TYPE, marker)};
case PDEMarkerFactory.M_SINGLETON_DIR_NOT_SET :
return new IMarkerResolution[] {new AddSingletonToSymbolicName(AbstractPDEMarkerResolution.RENAME_TYPE, true, marker)};
case PDEMarkerFactory.M_SINGLETON_ATT_NOT_SET :
return new IMarkerResolution[] {new AddSingletonToSymbolicName(AbstractPDEMarkerResolution.RENAME_TYPE, false,marker)};
case PDEMarkerFactory.M_SINGLETON_DIR_NOT_SUPPORTED :
return new IMarkerResolution[] {new UnsupportedSingletonDirectiveResolution(AbstractPDEMarkerResolution.RENAME_TYPE, marker)};
case PDEMarkerFactory.M_PROJECT_BUILD_ORDER_ENTRIES :
return new IMarkerResolution[] {new RemoveStaticProjectReferences(AbstractPDEMarkerResolution.REMOVE_TYPE, marker)};
case PDEMarkerFactory.M_EXPORT_PKG_NOT_EXIST :
return getUnresolvedExportProposals(marker);
case PDEMarkerFactory.M_IMPORT_PKG_NOT_AVAILABLE :
return getUnresolvedImportPackageProposals(marker);
case PDEMarkerFactory.M_REQ_BUNDLE_NOT_AVAILABLE :
return getUnresolvedBundle(marker);
case PDEMarkerFactory.M_UNKNOWN_ACTIVATOR :
return new IMarkerResolution[] {new CreateManifestClassResolution(AbstractPDEMarkerResolution.CREATE_TYPE, Constants.BUNDLE_ACTIVATOR, marker), new ChooseManifestClassResolution(AbstractPDEMarkerResolution.RENAME_TYPE, Constants.BUNDLE_ACTIVATOR, marker)};
case PDEMarkerFactory.M_UNKNOWN_CLASS :
return new IMarkerResolution[] {new CreateManifestClassResolution(AbstractPDEMarkerResolution.CREATE_TYPE, ICoreConstants.PLUGIN_CLASS, marker), new ChooseManifestClassResolution(AbstractPDEMarkerResolution.RENAME_TYPE, ICoreConstants.PLUGIN_CLASS, marker)};
case PDEMarkerFactory.M_DIRECTIVE_HAS_NO_EFFECT :
return getRemoveInternalDirectiveResolution(marker);
case PDEMarkerFactory.M_MISMATCHED_EXEC_ENV :
return new IMarkerResolution[] {
new UpdateClasspathResolution(AbstractPDEMarkerResolution.RENAME_TYPE, marker),
new UpdateExecutionEnvironment(AbstractPDEMarkerResolution.RENAME_TYPE, marker) };
case PDEMarkerFactory.M_UNKNOW_EXEC_ENV :
return new IMarkerResolution[] {
new RemoveUnknownExecEnvironments(AbstractPDEMarkerResolution.REMOVE_TYPE, marker) };
case PDEMarkerFactory.M_EXEC_ENV_TOO_LOW:
return new IMarkerResolution[] {
new ReplaceExecEnvironment(AbstractPDEMarkerResolution.RENAME_TYPE, marker) };
case PDEMarkerFactory.M_DEPRECATED_IMPORT_SERVICE :
return new IMarkerResolution[] {new RemoveImportExportServicesResolution(AbstractPDEMarkerResolution.REMOVE_TYPE, ICoreConstants.IMPORT_SERVICE, marker)};
case PDEMarkerFactory.M_DEPRECATED_EXPORT_SERVICE :
return new IMarkerResolution[] {new RemoveImportExportServicesResolution(AbstractPDEMarkerResolution.REMOVE_TYPE, ICoreConstants.EXPORT_SERVICE, marker)};
case PDEMarkerFactory.M_UNECESSARY_DEP :
return new IMarkerResolution[] {new RemoveRequireBundleResolution(AbstractPDEMarkerResolution.REMOVE_TYPE, marker.getAttribute("bundleId", null), marker)}; //$NON-NLS-1$
case PDEMarkerFactory.M_MISSING_EXPORT_PKGS :
return new IMarkerResolution[] { new AddExportPackageMarkerResolution(marker,AbstractPDEMarkerResolution.CREATE_TYPE), new AddExportPackageInternalDirectiveMarkerResolution(marker,AbstractPDEMarkerResolution.CREATE_TYPE, marker.getAttribute("packages", null)) }; //$NON-NLS-1$
case PDEMarkerFactory.B_REMOVE_SLASH_FILE_ENTRY :
return new IMarkerResolution[] {new RemoveSeperatorBuildEntryResolution(AbstractPDEMarkerResolution.RENAME_TYPE, marker)};
case PDEMarkerFactory.B_APPEND_SLASH_FOLDER_ENTRY :
return new IMarkerResolution[] {new AppendSeperatorBuildEntryResolution(AbstractPDEMarkerResolution.RENAME_TYPE, marker)};
case PDEMarkerFactory.B_ADDITION :
return getBuildEntryAdditionResolutions(marker, null);
case PDEMarkerFactory.B_JAVA_ADDDITION :
return getBuildEntryAdditionResolutions(marker, PDEUIMessages.MultiFixResolution_JavaFixAll);
case PDEMarkerFactory.B_SOURCE_ADDITION :
return new IMarkerResolution[] {new AddSourceBuildEntryResolution(AbstractPDEMarkerResolution.CREATE_TYPE, marker)};
case PDEMarkerFactory.B_REMOVAL :
return new IMarkerResolution[] {new RemoveBuildEntryResolution(AbstractPDEMarkerResolution.REMOVE_TYPE, marker)};
case PDEMarkerFactory.B_REPLACE :
return new IMarkerResolution[] {new ReplaceBuildEntryResolution(AbstractPDEMarkerResolution.RENAME_TYPE, marker)};
case PDEMarkerFactory.P_ILLEGAL_XML_NODE :
return new IMarkerResolution[] {new RemoveNodeXMLResolution(AbstractPDEMarkerResolution.REMOVE_TYPE, marker)};
case PDEMarkerFactory.P_UNTRANSLATED_NODE :
return new IMarkerResolution[] {new ExternalizeResolution(AbstractPDEMarkerResolution.RENAME_TYPE, marker), new ExternalizeStringsResolution(AbstractPDEMarkerResolution.RENAME_TYPE, marker)};
case PDEMarkerFactory.P_UNKNOWN_CLASS :
return new IMarkerResolution[] {new CreateClassXMLResolution(AbstractPDEMarkerResolution.CREATE_TYPE, marker), new ChooseClassXMLResolution(AbstractPDEMarkerResolution.RENAME_TYPE, marker)};
case PDEMarkerFactory.P_USELESS_FILE :
return new IMarkerResolution[] {new DeletePluginBaseResolution(AbstractPDEMarkerResolution.REMOVE_TYPE, marker), new AddNewExtensionResolution(AbstractPDEMarkerResolution.CREATE_TYPE,marker), new AddNewExtensionPointResolution(AbstractPDEMarkerResolution.CREATE_TYPE, marker)};
case PDEMarkerFactory.M_DEPRECATED_PROVIDE_PACKAGE :
return new IMarkerResolution[] {new RenameProvidePackageResolution(AbstractPDEMarkerResolution.RENAME_TYPE,marker)};
case PDEMarkerFactory.M_EXECUTION_ENVIRONMENT_NOT_SET :
return new IMarkerResolution[] {new AddDefaultExecutionEnvironmentResolution(AbstractPDEMarkerResolution.CREATE_TYPE, marker)};
case PDEMarkerFactory.M_MISSING_BUNDLE_CLASSPATH_ENTRY :
return new IMarkerResolution[] {new AddBundleClassPathMarkerResolution(AbstractPDEMarkerResolution.CREATE_TYPE, marker)};
case PDEMarkerFactory.M_LAZYLOADING_HAS_NO_EFFECT :
return new IMarkerResolution[] {new RemoveLazyLoadingDirectiveResolution(AbstractPDEMarkerResolution.REMOVE_TYPE, marker.getAttribute("header", ICoreConstants.ECLIPSE_LAZYSTART), marker)}; //$NON-NLS-1$
case PDEMarkerFactory.M_NO_LINE_TERMINATION :
if (marker.getAttribute(PDEMarkerFactory.ATTR_HAS_CONTENT, true)) {
return new IMarkerResolution[] {new NoLineTerminationResolution(AbstractPDEMarkerResolution.CREATE_TYPE,marker)};
}
return new IMarkerResolution[] {new NoLineTerminationResolution(AbstractPDEMarkerResolution.REMOVE_TYPE, marker)};
case PDEMarkerFactory.M_R4_SYNTAX_IN_R3_BUNDLE :
return new IMarkerResolution[] {new AddBundleManifestVersionResolution(marker)};
case PDEMarkerFactory.M_SERVICECOMPONENT_MISSING_LAZY:
return new IMarkerResolution[] {
new AddActivationPolicyResolution(AbstractPDEMarkerResolution.CREATE_TYPE, marker) };
case PDEMarkerFactory.M_NO_AUTOMATIC_MODULE:
return new IMarkerResolution[] {
new AddAutomaticModuleResolution(AbstractPDEMarkerResolution.CREATE_TYPE, marker) };
case PDEMarkerFactory.M_CONFLICTING_AUTOMATIC_MODULE:
return new IMarkerResolution[] {
new RemoveRedundantAutomaticModuleHeader(AbstractPDEMarkerResolution.REMOVE_TYPE, marker) };
}
return NO_RESOLUTIONS;
}
/**
* Checks for the <<code>problemID</code> attribute first, failing
* that returns the <code>id</code> attribute.
*
* @param marker
* @return the problem id to consider when computing resolutions
*/
int getProblemId(IMarker marker) {
int problemID = marker.getAttribute(PDEMarkerFactory.PROBLEM_ID, PDEMarkerFactory.NO_RESOLUTION);
if (problemID != PDEMarkerFactory.NO_RESOLUTION) {
return problemID;
}
return marker.getAttribute("id", PDEMarkerFactory.NO_RESOLUTION); //$NON-NLS-1$
}
private IMarkerResolution[] getBuildEntryAdditionResolutions(IMarker marker, String multiFixDescription) {
ArrayList<IMarkerResolution2> resolutions = new ArrayList<>(2);
resolutions.add(new AddBuildEntryResolution(AbstractPDEMarkerResolution.CREATE_TYPE, marker));
for (int i = 0;; i++) {
try {
String entry = (String) marker.getAttribute(PDEMarkerFactory.BK_BUILD_ENTRY + '.' + i);
if (entry == null)
break;
String value = (String) marker.getAttribute(PDEMarkerFactory.BK_BUILD_TOKEN + '.' + i);
resolutions.add(new AddBuildEntryResolution(AbstractPDEMarkerResolution.CREATE_TYPE, marker, entry, value));
} catch (CoreException e) {
break;
}
}
try {
String markerCategory = (String) marker.getAttribute(PDEMarkerFactory.CAT_ID);
int problemID = getProblemId(marker);
IMarker[] relatedMarkers = marker.getResource().findMarkers(marker.getType(), true, IResource.DEPTH_INFINITE);
for (int i = 0; i < relatedMarkers.length; i++) {
if (markerCategory.equals(relatedMarkers[i].getAttribute(PDEMarkerFactory.CAT_ID)) && getProblemId(relatedMarkers[i]) == problemID && !marker.equals(relatedMarkers[i])) {
resolutions.add(new MultiFixResolution(marker, multiFixDescription));
break;
}
}
} catch (CoreException e) {
}
return resolutions.toArray(new IMarkerResolution[resolutions.size()]);
}
private IMarkerResolution[] getRemoveInternalDirectiveResolution(IMarker marker) {
String packageName = marker.getAttribute("packageName", (String) null); //$NON-NLS-1$
if (packageName != null) {
IResource res = marker.getResource();
if (res != null)
return new IMarkerResolution[] {new RemoveInternalDirectiveEntryResolution(AbstractPDEMarkerResolution.REMOVE_TYPE, packageName,marker)};
}
return NO_RESOLUTIONS;
}
private IMarkerResolution[] getUnresolvedExportProposals(IMarker marker) {
String packageName = marker.getAttribute("packageName", (String) null); //$NON-NLS-1$
if (packageName != null) {
IResource res = marker.getResource();
if (res != null)
return new IMarkerResolution[] {new RemoveExportPackageResolution(AbstractPDEMarkerResolution.REMOVE_TYPE, marker)};
}
return NO_RESOLUTIONS;
}
private IMarkerResolution[] getUnresolvedImportPackageProposals(IMarker marker) {
String packageName = marker.getAttribute("packageName", (String) null); //$NON-NLS-1$
if (packageName == null)
return NO_RESOLUTIONS;
boolean optionalPkg = marker.getAttribute("optional", false); //$NON-NLS-1$
if (optionalPkg)
return new IMarkerResolution[] {new RemoveImportPackageResolution(AbstractPDEMarkerResolution.REMOVE_TYPE, marker), new ConfigureTargetPlatformResolution()};
return new IMarkerResolution[] {new RemoveImportPackageResolution(AbstractPDEMarkerResolution.REMOVE_TYPE, marker), new OptionalImportPackageResolution(AbstractPDEMarkerResolution.RENAME_TYPE, packageName, marker), new ConfigureTargetPlatformResolution()};
}
private IMarkerResolution[] getUnresolvedBundle(IMarker marker) {
String bundleId = marker.getAttribute("bundleId", (String) null); //$NON-NLS-1$
if (bundleId == null){
PDEState pdeState = TargetPlatformHelper.getPDEState();
if (pdeState != null) {
IPluginModelBase[] targetModels = pdeState.getTargetModels();
if (targetModels != null && targetModels.length == 0) {
return new IMarkerResolution[] { new ConfigureTargetPlatformResolution()};
}
}
return NO_RESOLUTIONS;
}
boolean optionalBundle = marker.getAttribute("optional", false); //$NON-NLS-1$
if (optionalBundle) {
return new IMarkerResolution[] {new RemoveRequireBundleResolution(AbstractPDEMarkerResolution.REMOVE_TYPE, bundleId, marker), new ConfigureTargetPlatformResolution()};
}
// IPreferenceStore store = PDEPlugin.getDefault().getPreferenceStore();
// boolean removeImports = store.getString(IPreferenceConstants.PROP_RESOLVE_IMPORTS).equals(IPreferenceConstants.VALUE_REMOVE_IMPORT);
return new IMarkerResolution[] {new RemoveRequireBundleResolution(AbstractPDEMarkerResolution.REMOVE_TYPE, bundleId, marker), new OptionalRequireBundleResolution(AbstractPDEMarkerResolution.RENAME_TYPE, marker), new ConfigureTargetPlatformResolution()
// new OrganizeRequireBundleResolution(AbstractPDEMarkerResolution.RENAME_TYPE, removeImports)
};
}
@Override
public boolean hasResolutions(IMarker marker) {
return getProblemId(marker) > 0;
}
}