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 static org.tmatesoft.hg.repo.HgRepository.TIP;
kitaev@213: 
kitaev@213: import java.io.IOException;
kitaev@213: import java.util.Calendar;
kitaev@213: import java.util.Collections;
kitaev@213: import java.util.ConcurrentModificationException;
kitaev@213: import java.util.LinkedList;
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.repo.HgChangelog.RawChangeset;
kitaev@213: import org.tmatesoft.hg.repo.HgChangelog;
kitaev@213: import org.tmatesoft.hg.repo.HgDataFile;
kitaev@213: import org.tmatesoft.hg.repo.HgRepository;
kitaev@213: import org.tmatesoft.hg.util.ByteChannel;
kitaev@213: import org.tmatesoft.hg.util.CancelledException;
kitaev@213: import org.tmatesoft.hg.util.Path;
kitaev@213: 
kitaev@213: 
kitaev@213: /**
kitaev@213:  * Access to changelog, 'hg log' command counterpart.
kitaev@213:  * 
kitaev@213:  * <pre>
kitaev@213:  * Usage:
kitaev@213:  *   new LogCommand().limit(20).branch("maintenance-2.1").user("me").execute(new MyHandler());
kitaev@213:  * </pre>
kitaev@213:  * Not thread-safe (each thread has to use own {@link HgLogCommand} instance).
kitaev@213:  * 
kitaev@213:  * @author Artem Tikhomirov
kitaev@213:  * @author TMate Software Ltd.
kitaev@213:  */
kitaev@213: public class HgLogCommand implements HgChangelog.Inspector {
kitaev@213: 
kitaev@213: 	private final HgRepository repo;
kitaev@213: 	private Set<String> users;
kitaev@213: 	private Set<String> branches;
kitaev@213: 	private int limit = 0, count = 0;
kitaev@213: 	private int startRev = 0, endRev = TIP;
kitaev@213: 	private Calendar date;
kitaev@213: 	private Path file;
kitaev@213: 	private boolean followHistory; // makes sense only when file != null
kitaev@213: 	private ChangesetTransformer csetTransform;
kitaev@213: 	private HgChangelog.ParentWalker parentHelper;
kitaev@213: 	
kitaev@213: 	public HgLogCommand(HgRepository hgRepo) {
kitaev@213: 		repo = hgRepo;
kitaev@213: 	}
kitaev@213: 
kitaev@213: 	/**
kitaev@213: 	 * Limit search to specified user. Multiple user names may be specified. Once set, user names can't be 
kitaev@213: 	 * cleared, use new command instance in such cases.
kitaev@213: 	 * @param user - full or partial name of the user, case-insensitive, non-null.
kitaev@213: 	 * @return <code>this</code> instance for convenience
kitaev@213: 	 * @throws IllegalArgumentException when argument is null
kitaev@213: 	 */
kitaev@213: 	public HgLogCommand user(String user) {
kitaev@213: 		if (user == null) {
kitaev@213: 			throw new IllegalArgumentException();
kitaev@213: 		}
kitaev@213: 		if (users == null) {
kitaev@213: 			users = new TreeSet<String>();
kitaev@213: 		}
kitaev@213: 		users.add(user.toLowerCase());
kitaev@213: 		return this;
kitaev@213: 	}
kitaev@213: 
kitaev@213: 	/**
kitaev@213: 	 * Limit search to specified branch. Multiple branch specification possible (changeset from any of these 
kitaev@213: 	 * would be included in result). If unspecified, all branches are considered. There's no way to clean branch selection 
kitaev@213: 	 * once set, create fresh new command instead.
kitaev@213: 	 * @param branch - branch name, case-sensitive, non-null.
kitaev@213: 	 * @return <code>this</code> instance for convenience
kitaev@213: 	 * @throws IllegalArgumentException when branch argument is null
kitaev@213: 	 */
kitaev@213: 	public HgLogCommand 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: 	// limit search to specific date
kitaev@213: 	// multiple?
kitaev@213: 	public HgLogCommand date(Calendar date) {
kitaev@213: 		this.date = date;
kitaev@213: 		// FIXME implement
kitaev@213: 		// isSet(field) - false => don't use in detection of 'same date'
kitaev@213: 		throw HgRepository.notImplemented();
kitaev@213: 	}
kitaev@213: 	
kitaev@213: 	/**
kitaev@213: 	 * 
kitaev@213: 	 * @param num - number of changeset to produce. Pass 0 to clear the limit. 
kitaev@213: 	 * @return <code>this</code> instance for convenience
kitaev@213: 	 */
kitaev@213: 	public HgLogCommand limit(int num) {
kitaev@213: 		limit = num;
kitaev@213: 		return this;
kitaev@213: 	}
kitaev@213: 
kitaev@213: 	/**
kitaev@213: 	 * Limit to specified subset of Changelog, [min(rev1,rev2), max(rev1,rev2)], inclusive.
kitaev@213: 	 * Revision may be specified with {@link HgRepository#TIP}  
kitaev@213: 	 * @param rev1 - local revision number
kitaev@213: 	 * @param rev2 - local revision number
kitaev@213: 	 * @return <code>this</code> instance for convenience
kitaev@213: 	 */
kitaev@213: 	public HgLogCommand range(int rev1, int rev2) {
kitaev@213: 		if (rev1 != TIP && rev2 != TIP) {
kitaev@213: 			startRev = rev2 < rev1 ? rev2 : rev1;
kitaev@213: 			endRev = startRev == rev2 ? rev1 : rev2;
kitaev@213: 		} else if (rev1 == TIP && rev2 != TIP) {
kitaev@213: 			startRev = rev2;
kitaev@213: 			endRev = rev1;
kitaev@213: 		} else {
kitaev@213: 			startRev = rev1;
kitaev@213: 			endRev = rev2;
kitaev@213: 		}
kitaev@213: 		return this;
kitaev@213: 	}
kitaev@213: 	
kitaev@213: 	/**
kitaev@213: 	 * Visit history of a given file only.
kitaev@213: 	 * @param file path relative to repository root. Pass <code>null</code> to reset.
kitaev@213: 	 * @param followCopyRename true to report changesets of the original file(-s), if copy/rename ever occured to the file. 
kitaev@213: 	 */
kitaev@213: 	public HgLogCommand file(Path file, boolean followCopyRename) {
kitaev@213: 		// multiple? Bad idea, would need to include extra method into Handler to tell start of next file
kitaev@213: 		this.file = file;
kitaev@213: 		followHistory = followCopyRename;
kitaev@213: 		return this;
kitaev@213: 	}
kitaev@213: 	
kitaev@213: 	/**
kitaev@213: 	 * Handy analog of {@link #file(Path, boolean)} when clients' paths come from filesystem and need conversion to repository's 
kitaev@213: 	 */
kitaev@213: 	public HgLogCommand file(String file, boolean followCopyRename) {
kitaev@213: 		return file(Path.create(repo.getToRepoPathHelper().rewrite(file)), followCopyRename);
kitaev@213: 	}
kitaev@213: 
kitaev@213: 	/**
kitaev@213: 	 * Similar to {@link #execute(org.tmatesoft.hg.repo.RawChangeset.Inspector)}, collects and return result as a list.
kitaev@213: 	 */
kitaev@213: 	public List<HgChangeset> execute() throws HgException {
kitaev@213: 		CollectHandler collector = new CollectHandler();
kitaev@213: 		execute(collector);
kitaev@213: 		return collector.getChanges();
kitaev@213: 	}
kitaev@213: 
kitaev@213: 	/**
kitaev@213: 	 * 
kitaev@213: 	 * @param handler callback to process changesets.
kitaev@213: 	 * @throws IllegalArgumentException when inspector argument is null
kitaev@213: 	 * @throws ConcurrentModificationException if this log command instance is already running
kitaev@213: 	 */
kitaev@213: 	public void execute(HgChangesetHandler handler) throws HgException {
kitaev@213: 		if (handler == null) {
kitaev@213: 			throw new IllegalArgumentException();
kitaev@213: 		}
kitaev@213: 		if (csetTransform != null) {
kitaev@213: 			throw new ConcurrentModificationException();
kitaev@213: 		}
kitaev@213: 		try {
kitaev@213: 			count = 0;
kitaev@213: 			HgChangelog.ParentWalker pw = parentHelper; // leave it uninitialized unless we iterate whole repo
kitaev@213: 			if (file == null) {
kitaev@213: 				pw = getParentHelper();
kitaev@213: 			}
kitaev@213: 			// ChangesetTransfrom creates a blank PathPool, and #file(String, boolean) above 
kitaev@213: 			// may utilize it as well. CommandContext? How about StatusCollector there as well?
kitaev@213: 			csetTransform = new ChangesetTransformer(repo, handler, pw);
kitaev@213: 			if (file == null) {
kitaev@213: 				repo.getChangelog().range(startRev, endRev, this);
kitaev@213: 			} else {
kitaev@213: 				HgDataFile fileNode = repo.getFileNode(file);
kitaev@213: 				fileNode.history(startRev, endRev, this);
kitaev@213: 				if (fileNode.isCopy()) {
kitaev@213: 					// even if we do not follow history, report file rename
kitaev@213: 					do {
kitaev@213: 						if (handler instanceof FileHistoryHandler) {
kitaev@213: 							FileRevision src = new FileRevision(repo, fileNode.getCopySourceRevision(), fileNode.getCopySourceName());
kitaev@213: 							FileRevision dst = new FileRevision(repo, fileNode.getRevision(0), fileNode.getPath());
kitaev@213: 							((FileHistoryHandler) handler).copy(src, dst);
kitaev@213: 						}
kitaev@213: 						if (limit > 0 && count >= limit) {
kitaev@213: 							// if limit reach, follow is useless.
kitaev@213: 							break;
kitaev@213: 						}
kitaev@213: 						if (followHistory) {
kitaev@213: 							fileNode = repo.getFileNode(fileNode.getCopySourceName());
kitaev@213: 							fileNode.history(this);
kitaev@213: 						}
kitaev@213: 					} while (followHistory && fileNode.isCopy());
kitaev@213: 				}
kitaev@213: 			}
kitaev@213: 		} finally {
kitaev@213: 			csetTransform = null;
kitaev@213: 		}
kitaev@213: 	}
kitaev@213: 
kitaev@213: 	//
kitaev@213: 	
kitaev@213: 	public void next(int revisionNumber, Nodeid nodeid, RawChangeset cset) {
kitaev@213: 		if (limit > 0 && count >= limit) {
kitaev@213: 			return;
kitaev@213: 		}
kitaev@213: 		if (branches != null && !branches.contains(cset.branch())) {
kitaev@213: 			return;
kitaev@213: 		}
kitaev@213: 		if (users != null) {
kitaev@213: 			String csetUser = cset.user().toLowerCase();
kitaev@213: 			boolean found = false;
kitaev@213: 			for (String u : users) {
kitaev@213: 				if (csetUser.indexOf(u) != -1) {
kitaev@213: 					found = true;
kitaev@213: 					break;
kitaev@213: 				}
kitaev@213: 			}
kitaev@213: 			if (!found) {
kitaev@213: 				return;
kitaev@213: 			}
kitaev@213: 		}
kitaev@213: 		if (date != null) {
kitaev@213: 			// FIXME
kitaev@213: 		}
kitaev@213: 		count++;
kitaev@213: 		csetTransform.next(revisionNumber, nodeid, cset);
kitaev@213: 	}
kitaev@213: 	
kitaev@213: 	private HgChangelog.ParentWalker getParentHelper() {
kitaev@213: 		if (parentHelper == null) {
kitaev@213: 			parentHelper = repo.getChangelog().new ParentWalker();
kitaev@213: 			parentHelper.init();
kitaev@213: 		}
kitaev@213: 		return parentHelper;
kitaev@213: 	}
kitaev@213: 
kitaev@213: 
kitaev@213: 	/**
kitaev@213: 	 * @deprecated Use {@link HgChangesetHandler} instead. This interface is left temporarily for compatibility.
kitaev@213: 	 */
kitaev@213: 	@Deprecated()
kitaev@213: 	public interface Handler extends HgChangesetHandler {
kitaev@213: 	}
kitaev@213: 	
kitaev@213: 	/**
kitaev@213: 	 * When {@link HgLogCommand} is executed against file, handler passed to {@link HgLogCommand#execute(HgChangesetHandler)} may optionally
kitaev@213: 	 * implement this interface to get information about file renames. Method {@link #copy(FileRevision, FileRevision)} would
kitaev@213: 	 * get invoked prior any changeset of the original file (if file history being followed) is reported via {@link #next(HgChangeset)}.
kitaev@213: 	 * 
kitaev@213: 	 * For {@link HgLogCommand#file(Path, boolean)} with renamed file path and follow argument set to false, 
kitaev@213: 	 * {@link #copy(FileRevision, FileRevision)} would be invoked for the first copy/rename in the history of the file, but not 
kitaev@213: 	 * followed by any changesets. 
kitaev@213: 	 *
kitaev@213: 	 * @author Artem Tikhomirov
kitaev@213: 	 * @author TMate Software Ltd.
kitaev@213: 	 */
kitaev@213: 	public interface FileHistoryHandler extends HgChangesetHandler {
kitaev@213: 		// XXX perhaps, should distinguish copy from rename? And what about merged revisions and following them?
kitaev@213: 		void copy(FileRevision from, FileRevision to);
kitaev@213: 	}
kitaev@213: 	
kitaev@213: 	public static class CollectHandler implements HgChangesetHandler {
kitaev@213: 		private final List<HgChangeset> result = new LinkedList<HgChangeset>();
kitaev@213: 
kitaev@213: 		public List<HgChangeset> getChanges() {
kitaev@213: 			return Collections.unmodifiableList(result);
kitaev@213: 		}
kitaev@213: 
kitaev@213: 		public void next(HgChangeset changeset) {
kitaev@213: 			result.add(changeset.clone());
kitaev@213: 		}
kitaev@213: 	}
kitaev@213: 
kitaev@213: 	public static final class FileRevision {
kitaev@213: 		private final HgRepository repo;
kitaev@213: 		private final Nodeid revision;
kitaev@213: 		private final Path path;
kitaev@213: 		
kitaev@213: 		/*package-local*/FileRevision(HgRepository hgRepo, Nodeid rev, Path p) {
kitaev@213: 			if (hgRepo == null || rev == null || p == null) {
kitaev@213: 				// since it's package local, it is our code to blame for non validated arguments
kitaev@213: 				throw new HgBadStateException();
kitaev@213: 			}
kitaev@213: 			repo = hgRepo;
kitaev@213: 			revision = rev;
kitaev@213: 			path = p;
kitaev@213: 		}
kitaev@213: 		
kitaev@213: 		public Path getPath() {
kitaev@213: 			return path;
kitaev@213: 		}
kitaev@213: 		public Nodeid getRevision() {
kitaev@213: 			return revision;
kitaev@213: 		}
kitaev@213: 		public void putContentTo(ByteChannel sink) throws HgDataStreamException, IOException, CancelledException {
kitaev@213: 			HgDataFile fn = repo.getFileNode(path);
kitaev@213: 			int localRevision = fn.getLocalRevision(revision);
kitaev@213: 			fn.contentWithFilters(localRevision, sink);
kitaev@213: 		}
kitaev@213: 	}
kitaev@213: }