Quick fix to provide an option to update user directive to mandatory

singleton true directive(if not present)

Author: Neha Burnwal

ui/org.eclipse.pde.core/src/org/eclipse/pde/internal/core/builders/BundleErrorReporter.java

@@ -431,7 +431,6 @@ private void validateSingleton(IHeader header, ManifestElement element) {
 		// must check the existence of plugin.xml file instead of using IPluginBase because if the bundle is not a singleton,
 		// it won't be registered with the extension registry and will always return 0 when querying extensions/extension points
 		boolean hasExtensions = base != null && PDEProject.getPluginXml(fProject).exists();
-
 		if (hasExtensions) {
 			if (TargetPlatformHelper.getTargetVersion() >= 3.1) {
 				if (!"true".equals(singletonDir)) { //$NON-NLS-1$
@@ -444,6 +443,21 @@ private void validateSingleton(IHeader header, ManifestElement element) {
 							return;
 						}
 					} else {
+						Enumeration<String> attrKeys = element.getDirectiveKeys();
+						int length = 0;
+						String key = null;
+						while (attrKeys.hasMoreElements()) {
+							key = attrKeys.nextElement();
+							length++;
+						}
+						if (length == 1) {
+							String message = NLS.bind(PDECoreMessages.BundleErrorReporter_singletonRequired,
+									Constants.SINGLETON_DIRECTIVE);
+							VirtualMarker marker = report(message, header.getLineNumber(), CompilerFlags.ERROR,
+									PDEMarkerFactory.M_SINGLETON_DIR_CHANGE, PDEMarkerFactory.CAT_FATAL);
+							addMarkerAttribute(marker, "userDirective", key); //$NON-NLS-1$
+							return;
+						}
 						String message = NLS.bind(PDECoreMessages.BundleErrorReporter_singletonRequired, Constants.SINGLETON_DIRECTIVE);
 						report(message, header.getLineNumber(), CompilerFlags.ERROR, PDEMarkerFactory.M_SINGLETON_DIR_NOT_SET, PDEMarkerFactory.CAT_FATAL);
 						return;

ui/org.eclipse.pde.core/src/org/eclipse/pde/internal/core/builders/PDEMarkerFactory.java

@@ -76,6 +76,7 @@ public class PDEMarkerFactory {
 	public static final int M_EXEC_ENV_TOO_LOW = 0x1029; // other problem
 	public static final int M_CONFLICTING_AUTOMATIC_MODULE = 0x1030; // other
 																		// problem
+	public static final int M_SINGLETON_DIR_CHANGE = 0x1033; // other problem
 
 	// build properties fixes
 	public static final int B_APPEND_SLASH_FOLDER_ENTRY = 0x2001;

ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/PDEUIMessages.java

@@ -716,6 +716,8 @@ public class PDEUIMessages extends NLS {
 	public static String Errors_CreationError;
 	public static String Errors_CreationError_NoWizard;
 
+	public static String UpdateSingleton_dir_label;
+
 	public static String UpdateSplashHandlerInModelAction_msgAddingExtension;
 
 	public static String UpdateSplashHandlerInModelAction_msgAddingExtensionPoint;

ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/correction/ResolutionGenerator.java

@@ -65,6 +65,8 @@ public IMarkerResolution[] getNonConfigSevResolutions(IMarker marker) {
 				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_DIR_CHANGE:
+				return updateSingletonProposal(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 :
@@ -151,6 +153,13 @@ public IMarkerResolution[] getNonConfigSevResolutions(IMarker marker) {
 		return NO_RESOLUTIONS;
 	}
 
+	private IMarkerResolution[] updateSingletonProposal(IMarker marker) {
+		return new IMarkerResolution[] {
+				new UpdateSingletonToSymbolicName(AbstractPDEMarkerResolution.RENAME_TYPE, true, marker),
+				new AddSingletonToSymbolicName(AbstractPDEMarkerResolution.RENAME_TYPE, true, marker) };
+
+	}
+
 	/**
 	 * Checks for the <<code>problemID</code> attribute first, failing
 	 * that returns the <code>id</code> attribute.

ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/correction/UpdateSingletonToSymbolicName.java

@@ -0,0 +1,49 @@
+package org.eclipse.pde.internal.ui.correction;
+
+import org.eclipse.core.resources.IMarker;
+import org.eclipse.osgi.util.NLS;
+import org.eclipse.pde.internal.core.TargetPlatformHelper;
+import org.eclipse.pde.internal.core.ibundle.IBundle;
+import org.eclipse.pde.internal.core.ibundle.IManifestHeader;
+import org.eclipse.pde.internal.core.text.bundle.Bundle;
+import org.eclipse.pde.internal.core.text.bundle.BundleModel;
+import org.eclipse.pde.internal.core.text.bundle.BundleSymbolicNameHeader;
+import org.eclipse.pde.internal.ui.PDEUIMessages;
+import org.osgi.framework.Constants;
+
+public class UpdateSingletonToSymbolicName extends AbstractManifestMarkerResolution {
+
+	private final boolean fisDirective;
+
+	public UpdateSingletonToSymbolicName(int type, boolean directive, IMarker marker) {
+		super(type, marker);
+		fisDirective = directive;
+	}
+
+	@Override
+	public String getLabel() {
+		String userDirective = marker.getAttribute("userDirective", null); //$NON-NLS-1$
+		return NLS.bind(PDEUIMessages.UpdateSingleton_dir_label, userDirective);
+	}
+
+	@Override
+	protected void createChange(BundleModel model) {
+		IBundle bundle = model.getBundle();
+		if (bundle instanceof Bundle bun) {
+			IManifestHeader header = bun.getManifestHeader(Constants.BUNDLE_SYMBOLICNAME);
+			if (header instanceof BundleSymbolicNameHeader) {
+				if (fisDirective && TargetPlatformHelper.getTargetVersion() >= 3.1)
+					bundle.setHeader(Constants.BUNDLE_MANIFESTVERSION, "2"); //$NON-NLS-1$
+				else if (!fisDirective && TargetPlatformHelper.getTargetVersion() < 3.1)
+					bundle.setHeader(Constants.BUNDLE_MANIFESTVERSION, null);
+				String entry = ((BundleSymbolicNameHeader) header).getValue();
+				int ind1 = entry.indexOf(';');
+				int ind2 = entry.indexOf(':');
+				String invalidDir = entry.substring(ind1 + 1, ind2);
+				((BundleSymbolicNameHeader) header).setDirective(invalidDir, null);
+				((BundleSymbolicNameHeader) header).setDirective(Constants.SINGLETON_DIRECTIVE, String.valueOf(true));
+			}
+		}
+	}
+
+}

ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/pderesources.properties

@@ -2520,6 +2520,7 @@ ControlValidationUtility_errorMsgKeyNotFound=The specified key is not present in
 ControlValidationUtility_errorMsgFilterInvalidSyntax=The specified platform filter contains invalid syntax
 PackageFinder_taskName=Searching class files for package references
 
+UpdateSingleton_dir_label=Update ''{0}'' to 'singleton' directive true
 UpdateSplashHandlerInModelAction_nameEmbedded=Embedded
 UpdateSplashHandlerInModelAction_nameRCP=RCP
 UpdateSplashHandlerInModelAction_templateTypeBrowser=Browser - An embedded HTML browser