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