bundles/org.eclipse.team.cvs.ui/src/org/eclipse/team/internal/ccvs/ui/tags/TagSource.java

/*******************************************************************************
 * Copyright (c) 2000, 2007 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.team.internal.ccvs.ui.tags;

import java.util.*;

import org.eclipse.core.resources.IProject;
import org.eclipse.core.resources.IResource;
import org.eclipse.core.resources.mapping.ResourceMapping;
import org.eclipse.core.runtime.*;
import org.eclipse.team.core.TeamException;
import org.eclipse.team.internal.ccvs.core.*;
import org.eclipse.team.internal.ccvs.core.resources.CVSWorkspaceRoot;

/**
 * A tag source provides access to a set of tags.
 */
public abstract class TagSource {
	
	/*
	 * Special constant representing the BASE tag
	 */
	public static final int BASE = -1;
	
	public static final TagSource EMPTY = new TagSource() {
		@Override
		public void commit(CVSTag[] tags, boolean replace, IProgressMonitor monitor) throws CVSException {
			// No-op
		}
		@Override
		public ICVSRepositoryLocation getLocation() {
			// TODO Auto-generated method stub
			return null;
		}
		@Override
		public String getShortDescription() {
			return "Empty"; //$NON-NLS-1$
		}
		@Override
		public CVSTag[] getTags(int type) {
			return new CVSTag[0];
		}
		@Override
		public CVSTag[] refresh(boolean bestEffort, IProgressMonitor monitor) throws TeamException {
			return new CVSTag[0];
		}
		@Override
		public ICVSResource[] getCVSResources() {
			return new ICVSResource[0];
		}
	};
	
	private ListenerList<ITagSourceChangeListener> listeners = new ListenerList<>(ListenerList.IDENTITY);
	
	/**
	 * Simple interface for providing notification when the tags
	 * for this source have changed.
	 */
	public interface ITagSourceChangeListener {
		void tagsChanged(TagSource source);
	}
	
	public static int[] convertIncludeFlaqsToTagTypes(int includeFlags) {
		List<Integer> types = new ArrayList<>();
		if ((includeFlags & TagSelectionArea.INCLUDE_BRANCHES) > 0)
			types.add(Integer.valueOf(CVSTag.BRANCH));
		if ((includeFlags & TagSelectionArea.INCLUDE_VERSIONS) > 0)
			types.add(Integer.valueOf(CVSTag.VERSION));
		if ((includeFlags & (TagSelectionArea.INCLUDE_HEAD_TAG)) > 0)
			types.add(Integer.valueOf(CVSTag.HEAD));
		if ((includeFlags & (TagSelectionArea.INCLUDE_DATES)) > 0)
			types.add(Integer.valueOf(CVSTag.DATE));
		if ((includeFlags & (TagSelectionArea.INCLUDE_BASE_TAG)) > 0)
			types.add(Integer.valueOf(BASE));
		int[] result = new int[types.size()];
		for (int i = 0; i < result.length; i++) {
			result[i] = types.get(i).intValue();
			
		}
		return result;
	}
	
	/**
	 * Create a tag source for the given folders
	 * @param folders one or more folders
	 * @return a tag source for the supplied folders
	 */
	public static TagSource create(ICVSFolder[] folders) {
		if (folders.length == 1) {
			return new SingleFolderTagSource(folders[0]);
		} else {
			return new MultiFolderTagSource(folders);
		}
	}
	
	/**
	 * Create a tag source for a list of resources
	 * @param resources one or more resources
	 * @return a tag source
	 */
	public static TagSource create(ICVSResource[] resources) {
		if (resources.length == 1 && !resources[0].isFolder())
			return new SingleFileTagSource((ICVSFile)resources[0]);
		return create(getFolders(resources));
	}

	private static ICVSFolder[] getFolders(ICVSResource[] resources) {
		HashSet<ICVSFolder> result = new HashSet<>();
		for (int i= 0; i < resources.length; i++) {
			result.add(getFirstFolder(resources[i]));
		}
		return result.toArray(new ICVSFolder[result.size()]);
	}

	/**
	 * Create a tag source for a list of resources
	 * @param resources one or more resources
	 * @return a tag source
	 */
	public static TagSource create(IResource[] resources) {
		return create(getCVSResources(getProjects(resources)));
	}
	
	/**
	 * Create a tag source for the given mappers.
	 * @param mappers the mappers
	 * @return a tag source 
	 */
	public static TagSource create(ResourceMapping[] mappers) {
		return create(getCVSResources(getProjects(mappers)));
	}
	
	private static IResource[] getProjects(ResourceMapping[] mappers) {
		Set<IProject> projects = new HashSet<>();
		for (int i = 0; i < mappers.length; i++) {
			ResourceMapping mapper = mappers[i];
			projects.addAll(Arrays.asList(mapper.getProjects()));
		}
		return projects.toArray(new IResource[projects.size()]);
	}

	private static IResource[] getProjects(IResource[] resources) {
		Set<IProject> result = new HashSet<>();
		for (int i = 0; i < resources.length; i++) {
			IResource resource = resources[i];
			result.add(resource.getProject());
		}
		return result.toArray(new IResource[result.size()]);
	}

	/**
	 * Return a tag source for a single remote folder
	 * @param remote the remote folder
	 * @return a tag source for that folder
	 */
	public static TagSource create(ICVSRemoteFolder remote) {
		return new SingleFolderTagSource(remote);
	}
	
	private static ICVSResource[] getCVSResources(IResource[] resources) {
		List<ICVSResource> cvsResources = new ArrayList<>();
		for (int i = 0; i < resources.length; i++) {
			IResource resource = resources[i];
			cvsResources.add(CVSWorkspaceRoot.getCVSResourceFor(resource));
		}
		return cvsResources.toArray(new ICVSResource[cvsResources.size()]);
	}

	private static ICVSFolder getFirstFolder(ICVSResource resource) {
		if (resource.isFolder()) {
			return (ICVSFolder)resource;
		} else {
			return resource.getParent();
		}
	}
	
	public CVSTag[] getTags(int type) {
		switch (type) {
			case BASE:
				return new CVSTag[] { CVSTag.BASE };
			case CVSTag.HEAD:
				return new CVSTag[] { CVSTag.DEFAULT };
		}
		return new CVSTag[0];
	}
	
	public CVSTag[] getTags(int[] types) {
		if (types.length == 0) {
			return new CVSTag[0];
		}
		if (types.length == 1) {
			return getTags(types[0]);
		}
		List<CVSTag> result = new ArrayList<>();
		for (int i = 0; i < types.length; i++) {
			int type = types[i];
			CVSTag[] tags = getTags(type);
			result.addAll(Arrays.asList(tags));
		}
		return result.toArray(new CVSTag[result.size()]);
	}

	/**
	 * Refresh the tags by contacting the server if appropriate
	 * @param monitor a progress monitor
	 * @param bestEffort if best effort is true, then the whole folder contents may be searched
	 * @return any discovered tags
	 */
	public abstract CVSTag[] refresh(boolean bestEffort, IProgressMonitor monitor) throws TeamException;
	
	public abstract ICVSRepositoryLocation getLocation();

	/**
	 * Return a short description of the tag source for displaying in UI.
	 * @return a short description of the tag source for displaying in UI.
	 */
	public abstract String getShortDescription();

	/**
	 * Commit a set of tag changes to the tag cache
	 * @param tags the tags that should be cached
	 * @param replace whether existing tags not in the list should be removed
	 * @param monitor a progress monitor
	 * @throws CVSException
	 */
	public abstract void commit(CVSTag[] tags, boolean replace, IProgressMonitor monitor) throws CVSException;
	
	public void addListener(ITagSourceChangeListener listener) {
		listeners.add(listener);
	}

	public void removeListener(ITagSourceChangeListener listener) {
		listeners.remove(listener);
	}
	
	/**
	 * Notify all listeners that the tags from this source may have changed
	 */
	public void fireChange() {
		Object[] list = listeners.getListeners();
		for (int i = 0; i < list.length; i++) {
			final ITagSourceChangeListener listener = (ITagSourceChangeListener)list[i];
			SafeRunner.run(new ISafeRunnable() {
				@Override
				public void handleException(Throwable exception) {
					// logged by run
				}
				@Override
				public void run() throws Exception {
					listener.tagsChanged(TagSource.this);
				}
			});
		}
	}
	
	public abstract ICVSResource[] getCVSResources();
}