import org.eclipse.team.core.ProjectSetSerializer;

	/**

	 * Answers an object for serializing and deserializing

	 * of references to CVS based projects.  Given a project, it can produce a

	 * UTF-8 encoded String which can be stored in a file.

	 * Given this String, it can load a project into the workspace.

	 * 

	 * @return the serializer (not <code>null</code>)

	 * @see org.eclipse.team.core.RepositoryProviderType#getProjectSetSerializer()

	 * @since 3.0

	 */

	public ProjectSetSerializer getProjectSetSerializer() {

		return new CVSProjectSetSerializer();

	}

package org.eclipse.team.internal.ccvs.core;

import java.util.ArrayList;

import java.util.Collection;

import java.util.HashMap;

import java.util.List;

import java.util.Map;

import java.util.StringTokenizer;

import org.eclipse.core.resources.IProject;

import org.eclipse.core.resources.ResourcesPlugin;

import org.eclipse.core.runtime.IProgressMonitor;

import org.eclipse.core.runtime.NullProgressMonitor;

import org.eclipse.core.runtime.SubProgressMonitor;

import org.eclipse.team.core.ProjectSetSerializationContext;

import org.eclipse.team.core.ProjectSetSerializer;

import org.eclipse.team.core.RepositoryProvider;

import org.eclipse.team.core.TeamException;

import org.eclipse.team.internal.ccvs.core.connection.CVSRepositoryLocation;

import org.eclipse.team.internal.ccvs.core.resources.CVSWorkspaceRoot;

import org.eclipse.team.internal.ccvs.core.syncinfo.FolderSyncInfo;

/**

 * An object for serializing and deserializing

 * of references to CVS based projects.  Given a project, it can produce a

 * UTF-8 encoded String which can be stored in a file.

 * Given this String, it can load a project into the workspace.

 * 

 * @since 3.0

 */

public class CVSProjectSetSerializer extends ProjectSetSerializer {

	/**

	 * Override superclass implementation to return an array of project references.

	 * 

	 * @see ProjectSetSerializer#asReference(IProject[], ProjectSetSerializationContext, IProgressMonitor)

	 */

	public String[] asReference(

		IProject[] projects,

		ProjectSetSerializationContext context,

		IProgressMonitor monitor)

		throws TeamException {

		String[] result = new String[projects.length];

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

			result[i] = asReference(projects[i]);

		return result;

	}

	/**

	 * Answer a string representing the specified project

	 * 

	 * @param project the project (not <code>null</code>)

	 * @return the project reference (not <code>null</code>)

	 * @throws CVSException

	 */

	private String asReference(IProject project) throws TeamException {

		StringBuffer buffer = new StringBuffer();

		buffer.append("1.0,"); //$NON-NLS-1$

		CVSTeamProvider provider = (CVSTeamProvider)RepositoryProvider.getProvider(project);

		CVSWorkspaceRoot root = provider.getCVSWorkspaceRoot();

		CVSRepositoryLocation location = CVSRepositoryLocation.fromString(root.getRemoteLocation().getLocation());

		location.setUserMuteable(true);

		String repoLocation = location.getLocation();

		buffer.append(repoLocation);

		buffer.append(","); //$NON-NLS-1$

		ICVSFolder folder = root.getLocalRoot();

		FolderSyncInfo syncInfo = folder.getFolderSyncInfo();

		String module = syncInfo.getRepository();

		buffer.append(module);

		buffer.append(","); //$NON-NLS-1$

		String projectName = folder.getName();

		buffer.append(projectName);

		CVSTag tag = syncInfo.getTag();

		if (tag != null) {

			if (tag.getType() != CVSTag.DATE) {

				buffer.append(","); //$NON-NLS-1$

				String tagName = tag.getName();

				buffer.append(tagName);

			}

		}

		return buffer.toString();

	}

	/**

	 * Override superclass implementation to load the referenced projects into the workspace.

	 * 

	 * @see org.eclipse.team.core.ProjectSetSerializer#addToWorkspace(java.lang.String[], org.eclipse.team.core.ProjectSetSerializationContext, org.eclipse.core.runtime.IProgressMonitor)

	 */

	public IProject[] addToWorkspace(

		String[] referenceStrings,

		ProjectSetSerializationContext context,

		IProgressMonitor originalMonitor)

		throws TeamException {

		IProgressMonitor monitor = originalMonitor;

		if (monitor == null)

			monitor = new NullProgressMonitor();

		else if (monitor.isCanceled())

			return new IProject[0];

		// Confirm the projects to be loaded

		Map infoMap = new HashMap(referenceStrings.length);

		IProject[] projects = asProjects(referenceStrings, infoMap);

		projects = confirmOverwrite(context, projects);

		if (projects == null)

			return new IProject[0];

		// Load the projects

		monitor.beginTask("", 20); //$NON-NLS-1$

		try {

			projects = createProjects(context, projects, new SubProgressMonitor(monitor, 1));

			if (projects == null)

				return new IProject[0];

			return checkout(projects, infoMap, new SubProgressMonitor(monitor, 19));

		}

		finally {

			monitor.done();

		}

	}

	/**

	 * Translate the reference strings into projects to be loaded

	 * and build a mapping of project to project load information.

	 * 

	 * @param referenceStrings project references

	 * @param infoMap a mapping of project to project load information

	 * @return the projects to be loaded

	 */

	private IProject[] asProjects(String[] referenceStrings, Map infoMap) throws CVSException {

		Collection result = new ArrayList();

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

			StringTokenizer tokenizer = new StringTokenizer(referenceStrings[i], ","); //$NON-NLS-1$

			String version = tokenizer.nextToken();

			// If this is a newer version, then ignore it

			if (!version.equals("1.0")) //$NON-NLS-1$

				continue;

			LoadInfo info = new LoadInfo(tokenizer);

			IProject proj = info.getProject();

			result.add(proj);

			infoMap.put(proj, info);

		}

		return (IProject[]) result.toArray(new IProject[result.size()]);

	}

	/**

	 * Checkout projects from the CVS repository

	 * 

	 * @param projects the projects to be loaded from the repository

	 * @param infoMap a mapping of project to project load information

	 * @param monitor the progress monitor (not <code>null</code>)

	 */

	private IProject[] checkout(

		IProject[] projects,

		Map infoMap,

		IProgressMonitor monitor)

		throws TeamException {

		monitor.beginTask("", 1000 * projects.length); //$NON-NLS-1$

		List result = new ArrayList();

		try {

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

				if (monitor.isCanceled())

					break;

				IProject project = projects[i];

				LoadInfo info = (LoadInfo) infoMap.get(project);

				if (info != null && info.checkout(new SubProgressMonitor(monitor, 1000)))

					result.add(project);

			}

		}

		finally {

			monitor.done();

		}

		return (IProject[])result.toArray(new IProject[result.size()]);

	}

	/**

	 * Internal class for adding projects to the workspace 

	 */

	class LoadInfo {

		private final ICVSRepositoryLocation repositoryLocation;

		private final String module;

		private final IProject project;

		private final CVSTag tag;

		/**

		 * Construct a new instance wrappering the specified project reference

		 * 

		 * @param projRef the project reference

		 */

		LoadInfo(StringTokenizer tokenizer) throws CVSException {

			String repo = tokenizer.nextToken();

			repositoryLocation = getRepositoryLocationFromString(repo);

			module = tokenizer.nextToken();

			String projectName = tokenizer.nextToken();

			project = ResourcesPlugin.getWorkspace().getRoot().getProject(projectName);

			if (tokenizer.hasMoreTokens()) {

				String tagName = tokenizer.nextToken();

				tag = new CVSTag(tagName, CVSTag.BRANCH);

			}

			else {

				tag = null;

			}

		}

		/**

		 * Answer the project referenced by this object.

		 * The project may or may not already exist.

		 * 

		 * @return the project (not <code>null</code>)

		 */

		private IProject getProject() {

			return project;

		}

		/**

		 * Checkout the project specified by this reference.

		 * 

		 * @param monitor project monitor

		 * @return true if loaded, else false

		 * @throws TeamException

		 */

		boolean checkout(IProgressMonitor monitor) throws TeamException {

			if (repositoryLocation == null)

				return false;

			CVSWorkspaceRoot.checkout(

				repositoryLocation,

				project,

				module,

				tag,

				monitor);

			return true;

		}

	}

	/**

	 * Extract the CVS repository location information from the specified string

	 * 

	 * @param repo the repository location as a string

	 * @return the CVS repository information

	 * @throws CVSException

	 */

	private static ICVSRepositoryLocation getRepositoryLocationFromString(String repo) throws CVSException {

		// create the new location

		ICVSRepositoryLocation newLocation = CVSRepositoryLocation.fromString(repo);

		if (newLocation.getUsername() == null || newLocation.getUsername().length() == 0) {

			// look for an existing location that matched

			ICVSRepositoryLocation[] locations = CVSProviderPlugin.getPlugin().getKnownRepositories();

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

				ICVSRepositoryLocation location = locations[i];

				if (location.getMethod() == newLocation.getMethod()

					&& location.getHost().equals(newLocation.getHost())

					&& location.getPort() == newLocation.getPort()

					&& location.getRootDirectory().equals(newLocation.getRootDirectory()))

						return location;

			}

		}

		return newLocation;

	}

}