tikhomirov@538: /*
tikhomirov@538:  * Copyright (c) 2013 TMate Software Ltd
tikhomirov@538:  *  
tikhomirov@538:  * This program is free software; you can redistribute it and/or modify
tikhomirov@538:  * it under the terms of the GNU General Public License as published by
tikhomirov@538:  * the Free Software Foundation; version 2 of the License.
tikhomirov@538:  *
tikhomirov@538:  * This program is distributed in the hope that it will be useful,
tikhomirov@538:  * but WITHOUT ANY WARRANTY; without even the implied warranty of
tikhomirov@538:  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
tikhomirov@538:  * GNU General Public License for more details.
tikhomirov@538:  *
tikhomirov@538:  * For information on how to redistribute this software under
tikhomirov@538:  * the terms of a license other than GNU General Public License
tikhomirov@538:  * contact TMate Software at support@hg4j.com
tikhomirov@538:  */
tikhomirov@591: package org.tmatesoft.hg.internal;
tikhomirov@538: 
tikhomirov@612: import static org.tmatesoft.hg.repo.HgRepository.DEFAULT_BRANCH_NAME;
tikhomirov@538: import static org.tmatesoft.hg.repo.HgRepository.NO_REVISION;
tikhomirov@636: import static org.tmatesoft.hg.repo.HgRepositoryFiles.*;
tikhomirov@612: import static org.tmatesoft.hg.repo.HgRepositoryFiles.Branch;
tikhomirov@617: import static org.tmatesoft.hg.repo.HgRepositoryFiles.UndoBranch;
tikhomirov@612: import static org.tmatesoft.hg.util.LogFacility.Severity.Error;
tikhomirov@538: 
tikhomirov@612: import java.io.File;
tikhomirov@612: import java.io.FileOutputStream;
tikhomirov@636: import java.io.FileWriter;
tikhomirov@539: import java.io.IOException;
tikhomirov@539: import java.util.ArrayList;
tikhomirov@538: import java.util.HashMap;
tikhomirov@538: import java.util.LinkedHashMap;
tikhomirov@538: import java.util.Map;
tikhomirov@559: import java.util.Set;
tikhomirov@538: import java.util.TreeMap;
tikhomirov@559: import java.util.TreeSet;
tikhomirov@538: 
tikhomirov@586: import org.tmatesoft.hg.core.HgCommitCommand;
tikhomirov@588: import org.tmatesoft.hg.core.HgIOException;
tikhomirov@538: import org.tmatesoft.hg.core.HgRepositoryLockException;
tikhomirov@538: import org.tmatesoft.hg.core.Nodeid;
tikhomirov@618: import org.tmatesoft.hg.internal.DataSerializer.DataSource;
tikhomirov@591: import org.tmatesoft.hg.repo.HgChangelog;
tikhomirov@591: import org.tmatesoft.hg.repo.HgDataFile;
tikhomirov@628: import org.tmatesoft.hg.repo.HgRuntimeException;
tikhomirov@538: import org.tmatesoft.hg.util.Pair;
tikhomirov@538: import org.tmatesoft.hg.util.Path;
tikhomirov@538: 
tikhomirov@538: /**
tikhomirov@586:  * Name: CommitObject, FutureCommit or PendingCommit
tikhomirov@613:  * The only public API now: {@link HgCommitCommand}.
tikhomirov@538:  * 
tikhomirov@538:  * @author Artem Tikhomirov
tikhomirov@538:  * @author TMate Software Ltd.
tikhomirov@538:  */
tikhomirov@559: public final class CommitFacility {
tikhomirov@591: 	private final Internals repo;
tikhomirov@538: 	private final int p1Commit, p2Commit;
tikhomirov@618: 	private Map<Path, Pair<HgDataFile, DataSource>> files = new LinkedHashMap<Path, Pair<HgDataFile, DataSource>>();
tikhomirov@559: 	private Set<Path> removals = new TreeSet<Path>();
tikhomirov@586: 	private String branch, user;
tikhomirov@538: 
tikhomirov@591: 	public CommitFacility(Internals hgRepo, int parentCommit) {
tikhomirov@538: 		this(hgRepo, parentCommit, NO_REVISION);
tikhomirov@538: 	}
tikhomirov@538: 	
tikhomirov@591: 	public CommitFacility(Internals hgRepo, int parent1Commit, int parent2Commit) {
tikhomirov@538: 		repo = hgRepo;
tikhomirov@538: 		p1Commit = parent1Commit;
tikhomirov@538: 		p2Commit = parent2Commit;
tikhomirov@538: 		if (parent1Commit != NO_REVISION && parent1Commit == parent2Commit) {
tikhomirov@538: 			throw new IllegalArgumentException("Merging same revision is dubious");
tikhomirov@538: 		}
tikhomirov@538: 	}
tikhomirov@538: 
tikhomirov@538: 	public boolean isMerge() {
tikhomirov@538: 		return p1Commit != NO_REVISION && p2Commit != NO_REVISION;
tikhomirov@538: 	}
tikhomirov@538: 
tikhomirov@618: 	public void add(HgDataFile dataFile, DataSource content) {
tikhomirov@559: 		if (content == null) {
tikhomirov@559: 			throw new IllegalArgumentException();
tikhomirov@559: 		}
tikhomirov@559: 		removals.remove(dataFile.getPath());
tikhomirov@618: 		files.put(dataFile.getPath(), new Pair<HgDataFile, DataSource>(dataFile, content));
tikhomirov@538: 	}
tikhomirov@559: 
tikhomirov@559: 	public void forget(HgDataFile dataFile) {
tikhomirov@559: 		files.remove(dataFile.getPath());
tikhomirov@559: 		removals.add(dataFile.getPath());
tikhomirov@559: 	}
tikhomirov@559: 	
tikhomirov@559: 	public void branch(String branchName) {
tikhomirov@559: 		branch = branchName;
tikhomirov@559: 	}
tikhomirov@538: 	
tikhomirov@586: 	public void user(String userName) {
tikhomirov@586: 		user = userName;
tikhomirov@586: 	}
tikhomirov@586: 	
tikhomirov@617: 	// this method doesn't roll transaction back in case of failure, caller's responsibility
tikhomirov@617: 	// this method expects repository to be locked, if needed
tikhomirov@628: 	public Nodeid commit(String message, Transaction transaction) throws HgIOException, HgRepositoryLockException, HgRuntimeException {
tikhomirov@591: 		final HgChangelog clog = repo.getRepo().getChangelog();
tikhomirov@538: 		final int clogRevisionIndex = clog.getRevisionCount();
tikhomirov@538: 		ManifestRevision c1Manifest = new ManifestRevision(null, null);
tikhomirov@538: 		ManifestRevision c2Manifest = new ManifestRevision(null, null);
tikhomirov@607: 		final Nodeid p1Cset = p1Commit == NO_REVISION ? null : clog.getRevision(p1Commit);
tikhomirov@607: 		final Nodeid p2Cset = p2Commit == NO_REVISION ? null : clog.getRevision(p2Commit);
tikhomirov@538: 		if (p1Commit != NO_REVISION) {
tikhomirov@591: 			repo.getRepo().getManifest().walk(p1Commit, p1Commit, c1Manifest);
tikhomirov@538: 		}
tikhomirov@538: 		if (p2Commit != NO_REVISION) {
tikhomirov@591: 			repo.getRepo().getManifest().walk(p2Commit, p2Commit, c2Manifest);
tikhomirov@538: 		}
tikhomirov@538: //		Pair<Integer, Integer> manifestParents = getManifestParents();
tikhomirov@538: 		Pair<Integer, Integer> manifestParents = new Pair<Integer, Integer>(c1Manifest.revisionIndex(), c2Manifest.revisionIndex());
tikhomirov@538: 		TreeMap<Path, Nodeid> newManifestRevision = new TreeMap<Path, Nodeid>();
tikhomirov@538: 		HashMap<Path, Pair<Integer, Integer>> fileParents = new HashMap<Path, Pair<Integer,Integer>>();
tikhomirov@538: 		for (Path f : c1Manifest.files()) {
tikhomirov@591: 			HgDataFile df = repo.getRepo().getFileNode(f);
tikhomirov@559: 			Nodeid fileKnownRev1 = c1Manifest.nodeid(f), fileKnownRev2;
tikhomirov@559: 			final int fileRevIndex1 = df.getRevisionIndex(fileKnownRev1);
tikhomirov@539: 			final int fileRevIndex2;
tikhomirov@559: 			if ((fileKnownRev2 = c2Manifest.nodeid(f)) != null) {
tikhomirov@539: 				// merged files
tikhomirov@559: 				fileRevIndex2 = df.getRevisionIndex(fileKnownRev2);
tikhomirov@539: 			} else {
tikhomirov@539: 				fileRevIndex2 = NO_REVISION;
tikhomirov@539: 			}
tikhomirov@539: 				
tikhomirov@539: 			fileParents.put(f, new Pair<Integer, Integer>(fileRevIndex1, fileRevIndex2));
tikhomirov@559: 			newManifestRevision.put(f, fileKnownRev1);
tikhomirov@538: 		}
tikhomirov@538: 		//
tikhomirov@559: 		// Forget removed
tikhomirov@559: 		for (Path p : removals) {
tikhomirov@559: 			newManifestRevision.remove(p);
tikhomirov@559: 		}
tikhomirov@559: 		//
tikhomirov@636: 		saveCommitMessage(message);
tikhomirov@636: 		//
tikhomirov@559: 		// Register new/changed
tikhomirov@616: 		LinkedHashMap<Path, RevlogStream> newlyAddedFiles = new LinkedHashMap<Path, RevlogStream>();
tikhomirov@588: 		ArrayList<Path> touchInDirstate = new ArrayList<Path>();
tikhomirov@618: 		for (Pair<HgDataFile, DataSource> e : files.values()) {
tikhomirov@538: 			HgDataFile df = e.first();
tikhomirov@618: 			DataSource bds = e.second();
tikhomirov@538: 			Pair<Integer, Integer> fp = fileParents.get(df.getPath());
tikhomirov@538: 			if (fp == null) {
tikhomirov@538: 				// NEW FILE
tikhomirov@538: 				fp = new Pair<Integer, Integer>(NO_REVISION, NO_REVISION);
tikhomirov@538: 			}
tikhomirov@621: 			RevlogStream contentStream = repo.getImplAccess().getStream(df);
tikhomirov@621: 			if (!df.exists()) {
tikhomirov@616: 				newlyAddedFiles.put(df.getPath(), contentStream);
tikhomirov@539: 			}
tikhomirov@617: 			RevlogStreamWriter fileWriter = new RevlogStreamWriter(repo, contentStream, transaction);
tikhomirov@618: 			Nodeid fileRev = fileWriter.addRevision(bds, clogRevisionIndex, fp.first(), fp.second());
tikhomirov@538: 			newManifestRevision.put(df.getPath(), fileRev);
tikhomirov@588: 			touchInDirstate.add(df.getPath());
tikhomirov@538: 		}
tikhomirov@538: 		//
tikhomirov@538: 		// Manifest
tikhomirov@618: 		final ManifestEntryBuilder manifestBuilder = new ManifestEntryBuilder(repo.buildFileNameEncodingHelper());
tikhomirov@538: 		for (Map.Entry<Path, Nodeid> me : newManifestRevision.entrySet()) {
tikhomirov@538: 			manifestBuilder.add(me.getKey().toString(), me.getValue());
tikhomirov@538: 		}
tikhomirov@617: 		RevlogStreamWriter manifestWriter = new RevlogStreamWriter(repo, repo.getImplAccess().getManifestStream(), transaction);
tikhomirov@618: 		Nodeid manifestRev = manifestWriter.addRevision(manifestBuilder, clogRevisionIndex, manifestParents.first(), manifestParents.second());
tikhomirov@538: 		//
tikhomirov@538: 		// Changelog
tikhomirov@538: 		final ChangelogEntryBuilder changelogBuilder = new ChangelogEntryBuilder();
tikhomirov@538: 		changelogBuilder.setModified(files.keySet());
tikhomirov@612: 		changelogBuilder.branch(branch == null ? DEFAULT_BRANCH_NAME : branch);
tikhomirov@586: 		changelogBuilder.user(String.valueOf(user));
tikhomirov@618: 		changelogBuilder.manifest(manifestRev).comment(message);
tikhomirov@617: 		RevlogStreamWriter changelogWriter = new RevlogStreamWriter(repo, repo.getImplAccess().getChangelogStream(), transaction);
tikhomirov@618: 		Nodeid changesetRev = changelogWriter.addRevision(changelogBuilder, clogRevisionIndex, p1Commit, p2Commit);
tikhomirov@616: 		// TODO move fncache update to an external facility, along with dirstate and bookmark update
tikhomirov@591: 		if (!newlyAddedFiles.isEmpty() && repo.fncacheInUse()) {
tikhomirov@591: 			FNCacheFile fncache = new FNCacheFile(repo);
tikhomirov@616: 			for (Path p : newlyAddedFiles.keySet()) {
tikhomirov@616: 				fncache.addIndex(p);
tikhomirov@616: 				if (!newlyAddedFiles.get(p).isInlineData()) {
tikhomirov@616: 					fncache.addData(p);
tikhomirov@616: 				}
tikhomirov@539: 			}
tikhomirov@539: 			try {
tikhomirov@539: 				fncache.write();
tikhomirov@539: 			} catch (IOException ex) {
tikhomirov@539: 				// see comment above for fnchache.read()
tikhomirov@612: 				repo.getLog().dump(getClass(), Error, ex, "Failed to write fncache, error ignored");
tikhomirov@612: 			}
tikhomirov@612: 		}
tikhomirov@612: 		String oldBranchValue = DirstateReader.readBranch(repo);
tikhomirov@612: 		String newBranchValue = branch == null ? DEFAULT_BRANCH_NAME : branch;
tikhomirov@612: 		if (!oldBranchValue.equals(newBranchValue)) {
tikhomirov@619: 			// prepare undo.branch as described in http://mercurial.selenic.com/wiki/FileFormats#undo..2A
tikhomirov@617: 			File branchFile = transaction.prepare(repo.getRepositoryFile(Branch), repo.getRepositoryFile(UndoBranch));
tikhomirov@612: 			FileOutputStream fos = null;
tikhomirov@612: 			try {
tikhomirov@612: 				fos = new FileOutputStream(branchFile);
tikhomirov@622: 				fos.write(newBranchValue.getBytes(EncodingHelper.getUTF8().name())); // XXX Java 1.5
tikhomirov@612: 				fos.flush();
tikhomirov@617: 				fos.close();
tikhomirov@617: 				fos = null;
tikhomirov@617: 				transaction.done(branchFile);
tikhomirov@612: 			} catch (IOException ex) {
tikhomirov@617: 				transaction.failure(branchFile, ex);
tikhomirov@612: 				repo.getLog().dump(getClass(), Error, ex, "Failed to write branch information, error ignored");
tikhomirov@612: 			} finally {
tikhomirov@612: 				try {
tikhomirov@612: 					if (fos != null) {
tikhomirov@612: 						fos.close();
tikhomirov@612: 					}
tikhomirov@612: 				} catch (IOException ex) {
tikhomirov@612: 					repo.getLog().dump(getClass(), Error, ex, null);
tikhomirov@612: 				}
tikhomirov@539: 			}
tikhomirov@539: 		}
tikhomirov@617: 		// bring dirstate up to commit state, TODO share this code with HgAddRemoveCommand
tikhomirov@591: 		final DirstateBuilder dirstateBuilder = new DirstateBuilder(repo);
tikhomirov@591: 		dirstateBuilder.fillFrom(new DirstateReader(repo, new Path.SimpleSource()));
tikhomirov@588: 		for (Path p : removals) {
tikhomirov@588: 			dirstateBuilder.recordRemoved(p);
tikhomirov@588: 		}
tikhomirov@588: 		for (Path p : touchInDirstate) {
tikhomirov@588: 			dirstateBuilder.recordUncertain(p);
tikhomirov@588: 		}
tikhomirov@588: 		dirstateBuilder.parents(changesetRev, Nodeid.NULL);
tikhomirov@617: 		dirstateBuilder.serialize(transaction);
tikhomirov@605: 		// update bookmarks
tikhomirov@605: 		if (p1Commit != NO_REVISION || p2Commit != NO_REVISION) {
tikhomirov@605: 			repo.getRepo().getBookmarks().updateActive(p1Cset, p2Cset, changesetRev);
tikhomirov@605: 		}
tikhomirov@610: 		// TODO Revisit: might be reasonable to send out a "Repo changed" notification, to clear
tikhomirov@610: 		// e.g. cached branch, tags and so on, not to rely on file change detection methods?
tikhomirov@616: 		// The same notification might come useful once Pull is implemented
tikhomirov@538: 		return changesetRev;
tikhomirov@538: 	}
tikhomirov@636: 	
tikhomirov@636: 	private void saveCommitMessage(String message) throws HgIOException {
tikhomirov@636: 		File lastMessage = repo.getRepositoryFile(LastMessage);
tikhomirov@636: 		// do not attempt to write if we are going to fail anyway
tikhomirov@636: 		if ((lastMessage.isFile() && !lastMessage.canWrite()) || !lastMessage.getParentFile().canWrite()) {
tikhomirov@636: 			return;
tikhomirov@636: 		}
tikhomirov@636: 		FileWriter w = null;
tikhomirov@636: 		try {
tikhomirov@636: 			w = new FileWriter(lastMessage);
tikhomirov@636: 			w.write(message == null ? new String() : message);
tikhomirov@636: 			w.flush();
tikhomirov@636: 		} catch (IOException ex) {
tikhomirov@636: 			throw new HgIOException("Failed to save last commit message", ex, lastMessage);
tikhomirov@636: 		} finally {
tikhomirov@636: 			new FileUtils(repo.getLog()).closeQuietly(w, lastMessage);
tikhomirov@636: 		}
tikhomirov@636: 	}
tikhomirov@538: /*
tikhomirov@538: 	private Pair<Integer, Integer> getManifestParents() {
tikhomirov@538: 		return new Pair<Integer, Integer>(extractManifestRevisionIndex(p1Commit), extractManifestRevisionIndex(p2Commit));
tikhomirov@538: 	}
tikhomirov@538: 
tikhomirov@538: 	private int extractManifestRevisionIndex(int clogRevIndex) {
tikhomirov@538: 		if (clogRevIndex == NO_REVISION) {
tikhomirov@538: 			return NO_REVISION;
tikhomirov@538: 		}
tikhomirov@538: 		RawChangeset commitObject = repo.getChangelog().range(clogRevIndex, clogRevIndex).get(0);
tikhomirov@538: 		Nodeid manifestRev = commitObject.manifest();
tikhomirov@538: 		if (manifestRev.isNull()) {
tikhomirov@538: 			return NO_REVISION;
tikhomirov@538: 		}
tikhomirov@538: 		return repo.getManifest().getRevisionIndex(manifestRev);
tikhomirov@538: 	}
tikhomirov@538: */
tikhomirov@538: }