bundles/org.eclipse.team.cvs.core/src/org/eclipse/team/internal/ccvs/core/client/listeners/AdminKSubstListener.java

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

/*
 * (c) Copyright IBM Corp. 2000, 2002.
 * All Rights Reserved.
 */

import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.Path;
import org.eclipse.team.internal.ccvs.core.CVSException;
import org.eclipse.team.internal.ccvs.core.CVSStatus;
import org.eclipse.team.internal.ccvs.core.ICVSFile;
import org.eclipse.team.internal.ccvs.core.ICVSFolder;
import org.eclipse.team.internal.ccvs.core.Policy;
import org.eclipse.team.internal.ccvs.core.client.Command.KSubstOption;
import org.eclipse.team.internal.ccvs.core.syncinfo.FolderSyncInfo;
import org.eclipse.team.internal.ccvs.core.syncinfo.MutableResourceSyncInfo;
import org.eclipse.team.internal.ccvs.core.syncinfo.ResourceSyncInfo;

/**
 * Used with 'admin -ksubst' to capture lines of text that are issued
 * as confirmation that the remote keyword substitution mode has been
 * changed.  When encountered, updates the local ResourceSyncInfo for
 * the file in question to reflect
 * 
 * e.g.
 *   RCS file: path/filename,v
 *   done
 */
public class AdminKSubstListener implements ICommandOutputListener {
	private KSubstOption ksubstMode;
	
	public AdminKSubstListener(KSubstOption ksubstMode) {
		this.ksubstMode = ksubstMode;
	}
	
	public IStatus messageLine(String line, ICVSFolder commandRoot,
		IProgressMonitor monitor) {
		if (line.startsWith("RCS file:")) { //$NON-NLS-1$
			String rcsFile = line.substring(10).trim();
			if (! rcsFile.endsWith(",v")) { //$NON-NLS-1$
				return new CVSStatus(CVSStatus.ERROR,
					Policy.bind("AdminKSubstListener.expectedRCSFile", rcsFile)); //$NON-NLS-1$
			}
			String remoteRootLocation = null;
			try {
				FolderSyncInfo info = commandRoot.getFolderSyncInfo();
				remoteRootLocation = info.getRemoteLocation();
			} catch (CVSException e) {
				// XXX bad eating of exception
			}
			if (remoteRootLocation == null) {
				return new CVSStatus(CVSStatus.ERROR,
					Policy.bind("AdminKSubstListener.commandRootNotManaged")); //$NON-NLS-1$
			}
			IPath rcsFilePath = new Path(rcsFile.substring(0, rcsFile.length() - 2));
			IPath remoteRootPath = new Path(remoteRootLocation);
			if (! remoteRootPath.isPrefixOf(rcsFilePath)) {
				return new CVSStatus(CVSStatus.ERROR,
					Policy.bind("AdminKSubstListener.expectedChildOfCommandRoot", //$NON-NLS-1$
						rcsFilePath.toString(), remoteRootPath.toString()));
			}
			rcsFilePath = rcsFilePath.removeFirstSegments(remoteRootPath.segmentCount());
			try {
				ICVSFile file = commandRoot.getFile(rcsFilePath.toString());
				ResourceSyncInfo info = file.getSyncInfo();
				if (info != null) {
					// only update sync info if we have it locally
					MutableResourceSyncInfo newInfo = info.cloneMutable();
					newInfo.setKeywordMode(ksubstMode);
					file.setSyncInfo(newInfo);
				}
			} catch (CVSException e) {
				return new CVSStatus(CVSStatus.ERROR,
					Policy.bind("AdminKSubstListener.couldNotSetResourceSyncInfo", //$NON-NLS-1$
						rcsFilePath.toString(), e.toString()));
			}
		}
		return OK;
	}

	public IStatus errorLine(String line, ICVSFolder commandRoot,
		IProgressMonitor monitor) {
		// we don't expect to see anything on stderr if the command succeeds
		// possible errors include:
		//   cvs server: cannot open /repo/a.txt,v: Permission denied
		//   cvs server: failed to create lock directory for `/repo/folder' (/repo/folder/#cvs.lock): Permission denied
		//   cvs server: failed to remove lock /repo/folder/#cvs.wfl.fiji.4442: Permission denied
		//   cvs server: lock failed - giving up
		//   cvs [server aborted]: lock failed - giving up
		return new CVSStatus(CVSStatus.ERROR, CVSStatus.ERROR_LINE, line);
	}
}