<extension

             point="org.eclipse.jdt.ui.classpathFixProcessors">

          <classpathFixProcessor

                class="org.eclipse.pde.internal.ui.correction.java.UnresolvedImportFixProcessor"

                id="org.eclipse.pde.ui.unresolvedImportQuickFixProcessor"

                name="Unresolved Import Quick Fix Processor">

          </classpathFixProcessor>

       </extension>

/*******************************************************************************

 * Copyright (c) 2007 IBM Corporation and others.

 * All rights reserved. This program and the accompanying materials

 * are made available under the terms of the Eclipse Public License v1.0

 * which accompanies this distribution, and is available at

 * http://www.eclipse.org/legal/epl-v10.html

 *

 * Contributors:

 *     IBM Corporation - initial API and implementation

 *******************************************************************************/

package org.eclipse.pde.internal.ui.correction.java;

import java.util.HashSet;

import java.util.Iterator;

import java.util.Set;

import org.eclipse.core.resources.IProject;

import org.eclipse.core.runtime.CoreException;

import org.eclipse.core.runtime.IProgressMonitor;

import org.eclipse.core.runtime.OperationCanceledException;

import org.eclipse.core.runtime.Status;

import org.eclipse.jdt.core.IJavaProject;

import org.eclipse.jdt.ui.text.java.ClasspathFixProcessor;

import org.eclipse.ltk.core.refactoring.Change;

import org.eclipse.ltk.core.refactoring.RefactoringStatus;

import org.eclipse.osgi.service.resolver.BundleDescription;

import org.eclipse.osgi.service.resolver.ExportPackageDescription;

import org.eclipse.pde.core.IBaseModel;

import org.eclipse.pde.core.plugin.IPluginImport;

import org.eclipse.pde.internal.core.PDECore;

import org.eclipse.pde.internal.core.WorkspaceModelManager;

import org.eclipse.pde.internal.core.ibundle.IBundlePluginModelBase;

import org.eclipse.pde.internal.ui.util.ModelModification;

import org.eclipse.pde.internal.ui.util.PDEModelUtility;

import org.eclipse.swt.graphics.Image;

/**

 * Offers a classpath fix proposal if the broken import statement can be

 * fixed by adding a plugin dependency (required bundle or package import).

 * @since 3.4

 */

public class UnresolvedImportFixProcessor extends ClasspathFixProcessor {

	/* (non-Javadoc)

	 * @see org.eclipse.jdt.ui.text.java.ClasspathFixProcessor#getFixImportProposals(org.eclipse.jdt.core.IJavaProject, java.lang.String)

	 */

	public ClasspathFixProposal[] getFixImportProposals(IJavaProject project, String name) throws CoreException {

		// TODO Check if project is of a PDE nature (this might be handled already by extension point)

		if (project == null || !WorkspaceModelManager.isPluginProject(project.getProject())){

			return null;

		}

		int idx= name.lastIndexOf('.');

		String packageName= idx != -1 ? name.substring(0, idx) : null;

		String typeName= name.substring(idx + 1);

		if (typeName.length() == 1 && typeName.charAt(0) == '*') {

			typeName= null;

		}

		if (packageName != null){

			// Get the packages exported by all bundles, see if any can provide the required classes

			ExportPackageDescription[] knownPackages = PDECore.getDefault().getModelManager().getState().getState().getExportedPackages();

			Set validPackages = new HashSet();

			for (int i = 0; i < knownPackages.length; i++) {

				// TODO Is there a better way to compare, currently no checking of class name

				if (knownPackages[i].getName().equals(packageName)){

					validPackages.add(knownPackages[i]);

				}

			}

			// TODO Do we want to create a proposal for every valid package?  Consider using a wizard to choose?

			ClasspathFixProposal[] proposals = new ClasspathFixProposal[validPackages.size()];

			int counter = 0;

			Iterator validPackagesIter = validPackages.iterator();

			while (validPackagesIter.hasNext()) {

				ExportPackageDescription currentPackage = (ExportPackageDescription) validPackagesIter.next();

				proposals[counter] = new RequireBundleFixProposal(project,currentPackage);

			}

			if (proposals.length > 0){

				return proposals;

			}

		}

		// TODO Do we want to allow overridden processors to run? 

		return null;

	}

	/**

	 * Proposal to fix a broken import by adding a required bundle.

	 */

	class RequireBundleFixProposal extends ClasspathFixProposal{

		private IProject fProject;

		private BundleDescription fBundleDescription;

		/**

		 * Constructor

		 * @param project The project that needs the new required bundle

		 * @param packageDescription the package we want a dependency on

		 */

		public RequireBundleFixProposal(IJavaProject project, ExportPackageDescription packageDescription) {

			fProject = project.getProject();

			fBundleDescription = packageDescription.getExporter();

		}

		/* (non-Javadoc)

		 * @see org.eclipse.jdt.ui.text.java.ClasspathFixProcessor.ClasspathFixProposal#createChange(org.eclipse.core.runtime.IProgressMonitor)

		 */

		public Change createChange(IProgressMonitor monitor) throws CoreException {

			return new BundleRequirementChange(fProject,fBundleDescription);

		}

		/* (non-Javadoc)

		 * @see org.eclipse.jdt.ui.text.java.ClasspathFixProcessor.ClasspathFixProposal#getAdditionalProposalInfo()

		 */

		public String getAdditionalProposalInfo() {

			return "Adds a bundle to the required bundles for this project.";

		}

		/* (non-Javadoc)

		 * @see org.eclipse.jdt.ui.text.java.ClasspathFixProcessor.ClasspathFixProposal#getDisplayString()

		 */

		public String getDisplayString() {

			return "Add " + fBundleDescription.getName() + " to required bundles";

		}

		/* (non-Javadoc)

		 * @see org.eclipse.jdt.ui.text.java.ClasspathFixProcessor.ClasspathFixProposal#getImage()

		 */

		public Image getImage() {

			return null;

			// TODO Use image such as JavaPluginImages.get(JavaPluginImages.IMG_CORRECTION_CHANGE);

		}

		/* (non-Javadoc)

		 * @see org.eclipse.jdt.ui.text.java.ClasspathFixProcessor.ClasspathFixProposal#getRelevance()

		 */

		public int getRelevance() {

			return 8;

		}

	}

	/**

	 * Change that actually adds the required bundle dependency.

	 */

	class BundleRequirementChange extends Change{	

		private IProject fBaseProject;

		private BundleDescription fBundle;

		/**

		 * Constructor

		 * @param project the project to add the dependency to

		 * @param bundleDescription the bundle to add as a dependency

		 */

		public BundleRequirementChange(IProject project, BundleDescription bundleDescription){

			fBaseProject = project;

			fBundle = bundleDescription;

		}

		/* (non-Javadoc)

		 * @see org.eclipse.ltk.core.refactoring.Change#perform(org.eclipse.core.runtime.IProgressMonitor)

		 */

		public Change perform(IProgressMonitor pm) throws CoreException {

			// TODO if the IBaseModel is a org.eclipse.pde.internal.core.text.plugin.PluginModelBase, the IPluginImport should be a PluginImportNode that will make it work for 3.0 projects also

			ModelModification modelMod = new ModelModification(fBaseProject){

				protected void modifyModel(IBaseModel model, IProgressMonitor monitor) throws CoreException {

					if (model instanceof IBundlePluginModelBase) {

						addRequiredBundle(monitor, (IBundlePluginModelBase)model, fBundle);

					}

				}

			};

			PDEModelUtility.modifyModel(modelMod, pm);

			return null;

		}

		/* (non-Javadoc)

		 * @see org.eclipse.ltk.core.refactoring.Change#isValid(org.eclipse.core.runtime.IProgressMonitor)

		 */

		public RefactoringStatus isValid(IProgressMonitor pm) throws CoreException,	OperationCanceledException {

			return RefactoringStatus.create(Status.OK_STATUS);

		}

		/* (non-Javadoc)

		 * @see org.eclipse.ltk.core.refactoring.Change#initializeValidationData(org.eclipse.core.runtime.IProgressMonitor)

		 */

		public void initializeValidationData(IProgressMonitor pm) {

		}

		/* (non-Javadoc)

		 * @see org.eclipse.ltk.core.refactoring.Change#getName()

		 */

		public String getName() {

			return "Change to bundle requirements";

		}

		/* (non-Javadoc)

		 * @see org.eclipse.ltk.core.refactoring.Change#getModifiedElement()

		 */

		public Object getModifiedElement() {

			return fBaseProject;

		}

		/**

		 * Adds the given bundle to the list of required bundles

		 * @param monitor

		 * @param baseBundle

		 * @param addBundle

		 * @throws CoreException

		 */

		private void addRequiredBundle(IProgressMonitor monitor, IBundlePluginModelBase baseBundle, BundleDescription addBundle) throws CoreException {

			// TODO Does not check if the bundle already is in the manifest?

			IPluginImport pluginImport = baseBundle.createImport();

			pluginImport.setId(addBundle.getSymbolicName());

			baseBundle.getPluginBase().add(pluginImport);

		}

//		public static void organizeImportPackages(IBundle bundle, boolean removeImports) {

//			if (!(bundle instanceof Bundle))

//				return;

//			ImportPackageHeader header = (ImportPackageHeader)((Bundle)bundle).getManifestHeader(Constants.IMPORT_PACKAGE);

//			if (header == null)

//				return;

//			ImportPackageObject[] importedPackages = header.getPackages();

//			Set availablePackages = getAvailableExportedPackages();

//			// get Preference

//			for (int i = 0; i < importedPackages.length; i++) {

//				String pkgName = importedPackages[i].getName();

//				if (!availablePackages.contains(pkgName)){

//					if (removeImports)

//						header.removePackage(importedPackages[i]);

//					else {

//						importedPackages[i].setOptional(true);

//					}

//				}

//			}

//		}

	}

}