tikhomirov@181: /*
tikhomirov@181:  * Copyright (c) 2011 TMate Software Ltd
tikhomirov@181:  *  
tikhomirov@181:  * This program is free software; you can redistribute it and/or modify
tikhomirov@181:  * it under the terms of the GNU General Public License as published by
tikhomirov@181:  * the Free Software Foundation; version 2 of the License.
tikhomirov@181:  *
tikhomirov@181:  * This program is distributed in the hope that it will be useful,
tikhomirov@181:  * but WITHOUT ANY WARRANTY; without even the implied warranty of
tikhomirov@181:  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
tikhomirov@181:  * GNU General Public License for more details.
tikhomirov@181:  *
tikhomirov@181:  * For information on how to redistribute this software under
tikhomirov@181:  * the terms of a license other than GNU General Public License
tikhomirov@181:  * contact TMate Software at support@hg4j.com
tikhomirov@181:  */
tikhomirov@181: package org.tmatesoft.hg.core;
tikhomirov@181: 
tikhomirov@181: import java.util.List;
tikhomirov@194: import java.util.Set;
tikhomirov@194: import java.util.TreeSet;
tikhomirov@181: 
tikhomirov@192: import org.tmatesoft.hg.internal.RepositoryComparator;
tikhomirov@192: import org.tmatesoft.hg.repo.HgChangelog;
tikhomirov@192: import org.tmatesoft.hg.repo.HgRemoteRepository;
tikhomirov@181: import org.tmatesoft.hg.repo.HgRepository;
tikhomirov@181: import org.tmatesoft.hg.util.CancelledException;
tikhomirov@181: 
tikhomirov@181: /**
tikhomirov@192:  * Command to find out changes made in a local repository and missing at remote repository. 
tikhomirov@192:  * 
tikhomirov@181:  * @author Artem Tikhomirov
tikhomirov@181:  * @author TMate Software Ltd.
tikhomirov@181:  */
tikhomirov@181: public class HgOutgoingCommand {
tikhomirov@192: 
tikhomirov@192: 	private final HgRepository localRepo;
tikhomirov@192: 	private HgRemoteRepository remoteRepo;
tikhomirov@206: 	@SuppressWarnings("unused")
tikhomirov@181: 	private boolean includeSubrepo;
tikhomirov@192: 	private RepositoryComparator comparator;
tikhomirov@195: 	private HgChangelog.ParentWalker parentHelper;
tikhomirov@194: 	private Set<String> branches;
tikhomirov@181: 
tikhomirov@181: 	public HgOutgoingCommand(HgRepository hgRepo) {
tikhomirov@192: 		localRepo = hgRepo;
tikhomirov@181: 	}
tikhomirov@181: 
tikhomirov@181: 	/**
tikhomirov@192: 	 * @param hgRemote remoteRepository to compare against
tikhomirov@192: 	 * @return <code>this</code> for convenience
tikhomirov@192: 	 */
tikhomirov@192: 	public HgOutgoingCommand against(HgRemoteRepository hgRemote) {
tikhomirov@192: 		remoteRepo = hgRemote;
tikhomirov@192: 		comparator = null;
tikhomirov@192: 		return this;
tikhomirov@192: 	}
tikhomirov@192: 
tikhomirov@192: 	/**
tikhomirov@194: 	 * Select specific branch to pull. 
tikhomirov@194: 	 * Multiple branch specification possible (changeset from any of these would be included in result).
tikhomirov@194: 	 * Note, {@link #executeLite(Object)} does not respect this setting.
tikhomirov@192: 	 * 
tikhomirov@194: 	 * @param branch - branch name, case-sensitive, non-null.
tikhomirov@181: 	 * @return <code>this</code> for convenience
tikhomirov@194: 	 * @throws IllegalArgumentException when branch argument is null
tikhomirov@181: 	 */
tikhomirov@181: 	public HgOutgoingCommand branch(String branch) {
tikhomirov@194: 		if (branch == null) {
tikhomirov@194: 			throw new IllegalArgumentException();
tikhomirov@194: 		}
tikhomirov@194: 		if (branches == null) {
tikhomirov@194: 			branches = new TreeSet<String>();
tikhomirov@194: 		}
tikhomirov@194: 		branches.add(branch);
tikhomirov@194: 		return this;
tikhomirov@181: 	}
tikhomirov@181: 	
tikhomirov@181: 	/**
tikhomirov@192: 	 * PLACEHOLDER, NOT IMPLEMENTED YET.
tikhomirov@181: 	 * 
tikhomirov@181: 	 * @return <code>this</code> for convenience
tikhomirov@181: 	 */
tikhomirov@181: 	public HgOutgoingCommand subrepo(boolean include) {
tikhomirov@181: 		includeSubrepo = include;
tikhomirov@181: 		throw HgRepository.notImplemented();
tikhomirov@181: 	}
tikhomirov@181: 
tikhomirov@192: 	/**
tikhomirov@194: 	 * Lightweight check for outgoing changes. 
tikhomirov@194: 	 * Reported changes are from any branch (limits set by {@link #branch(String)} are not taken into account.
tikhomirov@192: 	 * 
tikhomirov@192: 	 * @param context
tikhomirov@192: 	 * @return list on local nodes known to be missing at remote server 
tikhomirov@192: 	 */
tikhomirov@181: 	public List<Nodeid> executeLite(Object context) throws HgException, CancelledException {
tikhomirov@192: 		return getComparator(context).getLocalOnlyRevisions();
tikhomirov@181: 	}
tikhomirov@181: 
tikhomirov@192: 	/**
tikhomirov@192: 	 * Complete information about outgoing changes
tikhomirov@192: 	 * 
tikhomirov@192: 	 * @param handler delegate to process changes
tikhomirov@192: 	 */
tikhomirov@205: 	public void executeFull(final HgChangesetHandler handler) throws HgException, CancelledException {
tikhomirov@192: 		if (handler == null) {
tikhomirov@192: 			throw new IllegalArgumentException("Delegate can't be null");
tikhomirov@192: 		}
tikhomirov@195: 		ChangesetTransformer inspector = new ChangesetTransformer(localRepo, handler, getParentHelper());
tikhomirov@194: 		inspector.limitBranches(branches);
tikhomirov@194: 		getComparator(handler).visitLocalOnlyRevisions(inspector);
tikhomirov@192: 	}
tikhomirov@192: 
tikhomirov@192: 	private RepositoryComparator getComparator(Object context) throws HgException, CancelledException {
tikhomirov@192: 		if (remoteRepo == null) {
tikhomirov@192: 			throw new IllegalArgumentException("Shall specify remote repository to compare against");
tikhomirov@192: 		}
tikhomirov@192: 		if (comparator == null) {
tikhomirov@195: 			comparator = new RepositoryComparator(getParentHelper(), remoteRepo);
tikhomirov@192: 			comparator.compare(context);
tikhomirov@192: 		}
tikhomirov@192: 		return comparator;
tikhomirov@181: 	}
tikhomirov@195: 	
tikhomirov@195: 	private HgChangelog.ParentWalker getParentHelper() {
tikhomirov@195: 		if (parentHelper == null) {
tikhomirov@195: 			parentHelper = localRepo.getChangelog().new ParentWalker();
tikhomirov@195: 			parentHelper.init();
tikhomirov@195: 		}
tikhomirov@195: 		return parentHelper;
tikhomirov@195: 	}
tikhomirov@195: 
tikhomirov@181: }