/*
* Copyright (c) 2013 TMate Software Ltd
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; version 2 of the License.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* For information on how to redistribute this software under
* the terms of a license other than GNU General Public License
* contact TMate Software at support@hg4j.com
*/
package org.tmatesoft.hg.internal;
import static org.tmatesoft.hg.repo.HgRepository.DEFAULT_BRANCH_NAME;
import static org.tmatesoft.hg.repo.HgRepository.NO_REVISION;
import static org.tmatesoft.hg.repo.HgRepositoryFiles.*;
import static org.tmatesoft.hg.util.LogFacility.Severity.Error;
import java.io.File;
import java.io.FileOutputStream;
import java.io.FileWriter;
import java.io.IOException;
import java.nio.ByteBuffer;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.Map;
import java.util.Set;
import java.util.TreeMap;
import java.util.TreeSet;
import org.tmatesoft.hg.core.HgCommitCommand;
import org.tmatesoft.hg.core.HgIOException;
import org.tmatesoft.hg.core.HgRepositoryLockException;
import org.tmatesoft.hg.core.Nodeid;
import org.tmatesoft.hg.internal.DataSerializer.ByteArraySerializer;
import org.tmatesoft.hg.internal.DataSerializer.DataSource;
import org.tmatesoft.hg.repo.HgChangelog;
import org.tmatesoft.hg.repo.HgDataFile;
import org.tmatesoft.hg.repo.HgPhase;
import org.tmatesoft.hg.repo.HgRuntimeException;
import org.tmatesoft.hg.util.ByteChannel;
import org.tmatesoft.hg.util.CancelledException;
import org.tmatesoft.hg.util.Pair;
import org.tmatesoft.hg.util.Path;
/**
* Name: CommitObject, FutureCommit or PendingCommit
* The only public API now: {@link HgCommitCommand}.
*
* @author Artem Tikhomirov
* @author TMate Software Ltd.
*/
public final class CommitFacility {
private final Internals repo;
private final int p1Commit, p2Commit;
private Map<Path, Pair<HgDataFile, DataSource>> files = new LinkedHashMap<Path, Pair<HgDataFile, DataSource>>();
private Set<Path> removals = new TreeSet<Path>();
private String branch, user;
public CommitFacility(Internals hgRepo, int parentCommit) {
this(hgRepo, parentCommit, NO_REVISION);
}
public CommitFacility(Internals hgRepo, int parent1Commit, int parent2Commit) {
repo = hgRepo;
p1Commit = parent1Commit;
p2Commit = parent2Commit;
if (parent1Commit != NO_REVISION && parent1Commit == parent2Commit) {
throw new IllegalArgumentException("Merging same revision is dubious");
}
}
public boolean isMerge() {
return p1Commit != NO_REVISION && p2Commit != NO_REVISION;
}
public void add(HgDataFile dataFile, DataSource content) {
if (content == null) {
throw new IllegalArgumentException();
}
removals.remove(dataFile.getPath());
files.put(dataFile.getPath(), new Pair<HgDataFile, DataSource>(dataFile, content));
}
public void forget(HgDataFile dataFile) {
files.remove(dataFile.getPath());
removals.add(dataFile.getPath());
}
public void branch(String branchName) {
branch = branchName;
}
public void user(String userName) {
user = userName;
}
// this method doesn't roll transaction back in case of failure, caller's responsibility
// this method expects repository to be locked, if needed
public Nodeid commit(String message, Transaction transaction) throws HgIOException, HgRepositoryLockException, HgRuntimeException {
final HgChangelog clog = repo.getRepo().getChangelog();
final int clogRevisionIndex = clog.getRevisionCount();
ManifestRevision c1Manifest = new ManifestRevision(null, null);
ManifestRevision c2Manifest = new ManifestRevision(null, null);
final Nodeid p1Cset = p1Commit == NO_REVISION ? null : clog.getRevision(p1Commit);
final Nodeid p2Cset = p2Commit == NO_REVISION ? null : clog.getRevision(p2Commit);
if (p1Commit != NO_REVISION) {
repo.getRepo().getManifest().walk(p1Commit, p1Commit, c1Manifest);
}
if (p2Commit != NO_REVISION) {
repo.getRepo().getManifest().walk(p2Commit, p2Commit, c2Manifest);
}
// Pair<Integer, Integer> manifestParents = getManifestParents();
Pair<Integer, Integer> manifestParents = new Pair<Integer, Integer>(c1Manifest.revisionIndex(), c2Manifest.revisionIndex());
TreeMap<Path, Nodeid> newManifestRevision = new TreeMap<Path, Nodeid>();
HashMap<Path, Pair<Integer, Integer>> fileParents = new HashMap<Path, Pair<Integer,Integer>>();
for (Path f : c1Manifest.files()) {
HgDataFile df = repo.getRepo().getFileNode(f);
Nodeid fileKnownRev1 = c1Manifest.nodeid(f), fileKnownRev2;
final int fileRevIndex1 = df.getRevisionIndex(fileKnownRev1);
final int fileRevIndex2;
if ((fileKnownRev2 = c2Manifest.nodeid(f)) != null) {
// merged files
fileRevIndex2 = df.getRevisionIndex(fileKnownRev2);
} else {
fileRevIndex2 = NO_REVISION;
}
fileParents.put(f, new Pair<Integer, Integer>(fileRevIndex1, fileRevIndex2));
newManifestRevision.put(f, fileKnownRev1);
}
//
// Forget removed
for (Path p : removals) {
newManifestRevision.remove(p);
}
//
saveCommitMessage(message);
//
// Register new/changed
FNCacheFile.Mediator fncache = new FNCacheFile.Mediator(repo, transaction);
ArrayList<Path> touchInDirstate = new ArrayList<Path>();
for (Pair<HgDataFile, DataSource> e : files.values()) {
HgDataFile df = e.first();
DataSource bds = e.second();
Pair<Integer, Integer> fp = fileParents.get(df.getPath());
if (fp == null) {
// NEW FILE, either just added or resurrected from p2
Nodeid fileRevInP2;
if ((fileRevInP2 = c2Manifest.nodeid(df.getPath())) != null) {
fp = new Pair<Integer, Integer>(df.getRevisionIndex(fileRevInP2), NO_REVISION);
} else {
// brand new
fp = new Pair<Integer, Integer>(NO_REVISION, NO_REVISION);
}
}
// TODO if fp.first() != NO_REVISION and fp.second() != NO_REVISION check if one
// revision is ancestor of another and use the latest as p1, then
Nodeid fileRev = null;
final boolean isNewFile = !df.exists();
if (fp.first() != NO_REVISION && fp.second() == NO_REVISION && !isNewFile) {
// compare file contents to see if anything has changed, and reuse old revision, if unchanged.
// XXX ineffective, need better access to revision conten
ByteArraySerializer bas = new ByteArraySerializer();
bds.serialize(bas);
final byte[] newContent = bas.toByteArray();
// unless there's a way to reset DataSource, replace it with the content just read
bds = new DataSerializer.ByteArrayDataSource(newContent);
if (new ComparatorChannel(newContent).same(df, fp.first())) {
fileRev = df.getRevision(fp.first());
}
}
if (fileRev == null) {
RevlogStream contentStream = repo.getImplAccess().getStream(df);
RevlogStreamWriter fileWriter = new RevlogStreamWriter(repo, contentStream, transaction);
fileRev = fileWriter.addRevision(bds, clogRevisionIndex, fp.first(), fp.second()).second();
if (isNewFile) {
// registerNew shall go after fileWriter.addRevision as it needs to know if data is inlined or not
fncache.registerNew(df.getPath(), contentStream);
}
}
newManifestRevision.put(df.getPath(), fileRev);
touchInDirstate.add(df.getPath());
}
//
final EncodingHelper encHelper = repo.buildFileNameEncodingHelper();
//
// Manifest
final ManifestEntryBuilder manifestBuilder = new ManifestEntryBuilder(encHelper);
for (Map.Entry<Path, Nodeid> me : newManifestRevision.entrySet()) {
manifestBuilder.add(me.getKey().toString(), me.getValue());
}
RevlogStreamWriter manifestWriter = new RevlogStreamWriter(repo, repo.getImplAccess().getManifestStream(), transaction);
Nodeid manifestRev = manifestWriter.addRevision(manifestBuilder, clogRevisionIndex, manifestParents.first(), manifestParents.second()).second();
//
// Changelog
final ChangelogEntryBuilder changelogBuilder = new ChangelogEntryBuilder(encHelper);
changelogBuilder.setModified(files.keySet());
changelogBuilder.branch(branch == null ? DEFAULT_BRANCH_NAME : branch);
changelogBuilder.user(String.valueOf(user));
changelogBuilder.manifest(manifestRev).comment(message);
RevlogStreamWriter changelogWriter = new RevlogStreamWriter(repo, repo.getImplAccess().getChangelogStream(), transaction);
Nodeid changesetRev = changelogWriter.addRevision(changelogBuilder, clogRevisionIndex, p1Commit, p2Commit).second();
// TODO move dirstate and bookmark update update to an external facility
fncache.complete();
String oldBranchValue = DirstateReader.readBranch(repo);
String newBranchValue = branch == null ? DEFAULT_BRANCH_NAME : branch;
if (!oldBranchValue.equals(newBranchValue)) {
// prepare undo.branch as described in http://mercurial.selenic.com/wiki/FileFormats#undo..2A
File branchFile = transaction.prepare(repo.getRepositoryFile(Branch), repo.getRepositoryFile(UndoBranch));
FileOutputStream fos = null;
try {
fos = new FileOutputStream(branchFile);
fos.write(newBranchValue.getBytes(EncodingHelper.getUTF8().name())); // XXX Java 1.5
fos.flush();
fos.close();
fos = null;
transaction.done(branchFile);
} catch (IOException ex) {
transaction.failure(branchFile, ex);
repo.getLog().dump(getClass(), Error, ex, "Failed to write branch information, error ignored");
} finally {
try {
if (fos != null) {
fos.close();
}
} catch (IOException ex) {
repo.getLog().dump(getClass(), Error, ex, null);
}
}
}
// bring dirstate up to commit state, TODO share this code with HgAddRemoveCommand
final DirstateBuilder dirstateBuilder = new DirstateBuilder(repo);
dirstateBuilder.fillFrom(new DirstateReader(repo, repo.getSessionContext().getPathFactory()));
for (Path p : removals) {
dirstateBuilder.recordRemoved(p);
}
for (Path p : touchInDirstate) {
dirstateBuilder.recordUncertain(p);
}
dirstateBuilder.parents(changesetRev, Nodeid.NULL);
dirstateBuilder.serialize(transaction);
// update bookmarks
if (p1Commit != NO_REVISION || p2Commit != NO_REVISION) {
repo.getRepo().getBookmarks().updateActive(p1Cset, p2Cset, changesetRev);
}
PhasesHelper phaseHelper = new PhasesHelper(repo);
HgPhase newCommitPhase = HgPhase.parse(repo.getRepo().getConfiguration().getStringValue("phases", "new-commit", HgPhase.Draft.mercurialString()));
phaseHelper.newCommitNode(changesetRev, newCommitPhase);
// TODO Revisit: might be reasonable to send out a "Repo changed" notification, to clear
// e.g. cached branch, tags and so on, not to rely on file change detection methods?
// The same notification might come useful once Pull is implemented
return changesetRev;
}
private void saveCommitMessage(String message) throws HgIOException {
File lastMessage = repo.getRepositoryFile(LastMessage);
// do not attempt to write if we are going to fail anyway
if ((lastMessage.isFile() && !lastMessage.canWrite()) || !lastMessage.getParentFile().canWrite()) {
return;
}
FileWriter w = null;
try {
w = new FileWriter(lastMessage);
w.write(message == null ? new String() : message);
w.flush();
} catch (IOException ex) {
throw new HgIOException("Failed to save last commit message", ex, lastMessage);
} finally {
new FileUtils(repo.getLog(), this).closeQuietly(w, lastMessage);
}
}
private static class ComparatorChannel implements ByteChannel {
private int index;
private final byte[] content;
public ComparatorChannel(byte[] contentToCompare) {
content = contentToCompare;
}
public int write(ByteBuffer buffer) throws IOException, CancelledException {
int consumed = 0;
while (buffer.hasRemaining()) {
byte b = buffer.get();
consumed++;
if (content[index++] != b) {
throw new CancelledException();
}
}
return consumed;
}
public boolean same(HgDataFile df, int fileRevIndex) {
index = 0;
try {
df.contentWithFilters(fileRevIndex, this);
return index == content.length;
} catch (CancelledException ex) {
// comparison failed, content differs, ok to go on
}
return false;
}
}
/*
private Pair<Integer, Integer> getManifestParents() {
return new Pair<Integer, Integer>(extractManifestRevisionIndex(p1Commit), extractManifestRevisionIndex(p2Commit));
}
private int extractManifestRevisionIndex(int clogRevIndex) {
if (clogRevIndex == NO_REVISION) {
return NO_REVISION;
}
RawChangeset commitObject = repo.getChangelog().range(clogRevIndex, clogRevIndex).get(0);
Nodeid manifestRev = commitObject.manifest();
if (manifestRev.isNull()) {
return NO_REVISION;
}
return repo.getManifest().getRevisionIndex(manifestRev);
}
*/
}