Revision absence is vital e.g. for missing parent from {@link HgChangelog#parents(int, int[], byte[], byte[])} call and tikhomirov@423: * to report cases when changeset records no corresponding manifest tikhomirov@423: * revision {@link HgManifest#walk(int, int, org.tmatesoft.hg.repo.HgManifest.Inspector)}. tikhomirov@423: * tikhomirov@423: *
Use as imaginary revision/empty repository is handy as an argument (contrary to {@link #BAD_REVISION})
tikhomirov@423: * e.g in a status operation to visit changes from the very beginning of a repository.
tikhomirov@405: */
tikhomirov@405: public static final int NO_REVISION = -1;
tikhomirov@405:
tikhomirov@405: /**
tikhomirov@405: * Name of the primary branch, "default".
tikhomirov@405: */
tikhomirov@252: public static final String DEFAULT_BRANCH_NAME = "default";
tikhomirov@5:
tikhomirov@237: private final File workingDir; // .hg/../
tikhomirov@74: private final String repoLocation;
tikhomirov@493: /*
tikhomirov@493: * normalized slashes but otherwise regular file names
tikhomirov@493: * the only front-end path rewrite, kept here as rest of the library shall
tikhomirov@493: * not bother with names normalization.
tikhomirov@493: */
tikhomirov@493: private final PathRewrite normalizePath;
tikhomirov@295: private final SessionContext sessionContext;
tikhomirov@74:
tikhomirov@97: private HgChangelog changelog;
tikhomirov@2: private HgManifest manifest;
tikhomirov@50: private HgTags tags;
tikhomirov@220: private HgBranches branches;
tikhomirov@231: private HgMergeState mergeState;
tikhomirov@239: private SubrepoManager subRepos;
tikhomirov@484: private HgBookmarks bookmarks;
tikhomirov@501: private HgExtensionsManager extManager;
tikhomirov@91: private HgIgnore ignore;
tikhomirov@331: private HgRepoConfig repoConfig;
tikhomirov@220:
tikhomirov@613: private HgRepositoryLock wdLock, storeLock;
tikhomirov@613:
tikhomirov@610: private final org.tmatesoft.hg.internal.Internals impl;
tikhomirov@610:
tikhomirov@430: /*
tikhomirov@430: * TODO [post-1.0] move to a better place, e.g. WorkingCopy container that tracks both dirstate and branches
tikhomirov@430: * (and, perhaps, undo, lastcommit and other similar information), and is change listener so that we don't need to
tikhomirov@430: * worry about this cached value become stale
tikhomirov@430: */
tikhomirov@430: private String wcBranch;
tikhomirov@430:
tikhomirov@430:
tikhomirov@74: HgRepository(String repositoryPath) {
tikhomirov@237: workingDir = null;
tikhomirov@74: repoLocation = repositoryPath;
tikhomirov@142: normalizePath = null;
tikhomirov@295: sessionContext = null;
tikhomirov@388: impl = null;
tikhomirov@1: }
tikhomirov@1:
tikhomirov@425: /**
tikhomirov@425: * @throws HgRuntimeException subclass thereof to indicate issues with the library. Runtime exception
tikhomirov@425: */
tikhomirov@425: HgRepository(SessionContext ctx, String repositoryPath, File repositoryRoot) throws HgRuntimeException {
tikhomirov@74: assert ".hg".equals(repositoryRoot.getName()) && repositoryRoot.isDirectory();
tikhomirov@148: assert repositoryPath != null;
tikhomirov@148: assert repositoryRoot != null;
tikhomirov@295: assert ctx != null;
tikhomirov@591: workingDir = repositoryRoot.getParentFile();
tikhomirov@237: if (workingDir == null) {
tikhomirov@591: throw new IllegalArgumentException(repositoryRoot.toString());
tikhomirov@237: }
tikhomirov@148: repoLocation = repositoryPath;
tikhomirov@295: sessionContext = ctx;
tikhomirov@591: impl = new Internals(this, repositoryRoot, new Internals.ImplAccess() {
tikhomirov@591:
tikhomirov@591: public RevlogStream getStream(HgDataFile df) {
tikhomirov@591: return df.content;
tikhomirov@591: }
tikhomirov@591: public RevlogStream getManifestStream() {
tikhomirov@591: return HgRepository.this.getManifest().content;
tikhomirov@591: }
tikhomirov@591: public RevlogStream getChangelogStream() {
tikhomirov@591: return HgRepository.this.getChangelog().content;
tikhomirov@591: }
tikhomirov@591: });
tikhomirov@610: normalizePath = impl.buildNormalizePathRewrite();
tikhomirov@1: }
tikhomirov@0:
tikhomirov@145: @Override
tikhomirov@145: public String toString() {
tikhomirov@145: return getClass().getSimpleName() + "[" + getLocation() + (isInvalid() ? "(BAD)" : "") + "]";
tikhomirov@145: }
tikhomirov@74:
tikhomirov@491: /**
tikhomirov@491: * Path to repository which has been used to initialize this instance. The value is always present, even
tikhomirov@491: * if no repository has been found at that location ({@link #isInvalid()} is true) and serves
tikhomirov@491: * as an extra description of the failure.
tikhomirov@491: *
tikhomirov@491: *
It's important to understand this is purely descriptive attribute, it's kept as close as possible to
tikhomirov@491: * original value users supply to {@link HgLookup}. To get actual repository location, use methods that
tikhomirov@491: * provide {@link File}, e.g. {@link #getWorkingDir()}
tikhomirov@491: *
tikhomirov@491: * @return repository location information, never null
tikhomirov@491: */
tikhomirov@74: public String getLocation() {
tikhomirov@591: return repoLocation; // XXX field to keep this is bit too much
tikhomirov@74: }
tikhomirov@74:
tikhomirov@74: public boolean isInvalid() {
tikhomirov@490: return impl == null || impl.isInvalid();
tikhomirov@74: }
tikhomirov@74:
tikhomirov@97: public HgChangelog getChangelog() {
tikhomirov@388: if (changelog == null) {
tikhomirov@591: RevlogStream content = impl.createChangelogStream();
tikhomirov@388: changelog = new HgChangelog(this, content);
tikhomirov@0: }
tikhomirov@388: return changelog;
tikhomirov@0: }
tikhomirov@2:
tikhomirov@74: public HgManifest getManifest() {
tikhomirov@388: if (manifest == null) {
tikhomirov@591: RevlogStream content = impl.createManifestStream();
tikhomirov@412: manifest = new HgManifest(this, content, impl.buildFileNameEncodingHelper());
tikhomirov@2: }
tikhomirov@388: return manifest;
tikhomirov@2: }
tikhomirov@50:
tikhomirov@482: /**
tikhomirov@610: * Access snapshot of repository tags.
tikhomirov@610: *
tikhomirov@482: * @throws HgRuntimeException subclass thereof to indicate issues with the library. Runtime exception
tikhomirov@482: */
tikhomirov@318: public HgTags getTags() throws HgInvalidControlFileException {
tikhomirov@50: if (tags == null) {
tikhomirov@610: tags = new HgTags(impl);
tikhomirov@610: tags.read();
tikhomirov@610: } else {
tikhomirov@610: tags.reloadIfChanged();
tikhomirov@50: }
tikhomirov@50: return tags;
tikhomirov@50: }
tikhomirov@50:
tikhomirov@482: /**
tikhomirov@610: * Access branch information. Returns a snapshot of branch information as it's available at the time of the call.
tikhomirov@610: * If repository get changed, use this method to obtain an up-to-date state.
tikhomirov@610: *
tikhomirov@484: * @return branch manager instance, never null
tikhomirov@482: * @throws HgRuntimeException subclass thereof to indicate issues with the library. Runtime exception
tikhomirov@482: */
tikhomirov@366: public HgBranches getBranches() throws HgInvalidControlFileException {
tikhomirov@610: final ProgressSupport ps = ProgressSupport.Factory.get(null);
tikhomirov@220: if (branches == null) {
tikhomirov@490: branches = new HgBranches(impl);
tikhomirov@610: branches.collect(ps);
tikhomirov@610: } else {
tikhomirov@610: branches.reloadIfChanged(ps);
tikhomirov@220: }
tikhomirov@220: return branches;
tikhomirov@220: }
tikhomirov@231:
tikhomirov@484: /**
tikhomirov@484: * Access state of the recent merge
tikhomirov@484: * @return merge state facility, never null
tikhomirov@484: */
tikhomirov@231: public HgMergeState getMergeState() {
tikhomirov@231: if (mergeState == null) {
tikhomirov@490: mergeState = new HgMergeState(impl);
tikhomirov@231: }
tikhomirov@231: return mergeState;
tikhomirov@231: }
tikhomirov@220:
tikhomirov@74: public HgDataFile getFileNode(String path) {
tikhomirov@292: CharSequence nPath = normalizePath.rewrite(path);
tikhomirov@571: Path p = sessionContext.getPathFactory().path(nPath);
tikhomirov@493: return getFileNode(p);
tikhomirov@74: }
tikhomirov@1:
tikhomirov@74: public HgDataFile getFileNode(Path path) {
tikhomirov@591: RevlogStream content = impl.resolveStoreFile(path);
tikhomirov@115: if (content == null) {
tikhomirov@115: return new HgDataFile(this, path);
tikhomirov@115: }
tikhomirov@74: return new HgDataFile(this, path, content);
tikhomirov@74: }
tikhomirov@2:
tikhomirov@142: /* clients need to rewrite path from their FS to a repository-friendly paths, and, perhaps, vice versa*/
tikhomirov@142: public PathRewrite getToRepoPathHelper() {
tikhomirov@74: return normalizePath;
tikhomirov@74: }
tikhomirov@284:
tikhomirov@284: /**
tikhomirov@348: * @return pair of values, {@link Pair#first()} and {@link Pair#second()} are respective parents, never null.
tikhomirov@348: * @throws HgInvalidControlFileException if attempt to read information about working copy parents from dirstate failed
tikhomirov@284: */
tikhomirov@348: public Pairnull.
tikhomirov@348: * @throws HgInvalidControlFileException if attempt to read branch name failed.
tikhomirov@252: */
tikhomirov@348: public String getWorkingCopyBranchName() throws HgInvalidControlFileException {
tikhomirov@430: if (wcBranch == null) {
tikhomirov@526: wcBranch = DirstateReader.readBranch(impl);
tikhomirov@430: }
tikhomirov@430: return wcBranch;
tikhomirov@252: }
tikhomirov@2:
tikhomirov@237: /**
tikhomirov@237: * @return location where user files (shall) reside
tikhomirov@237: */
tikhomirov@237: public File getWorkingDir() {
tikhomirov@237: return workingDir;
tikhomirov@237: }
tikhomirov@239:
tikhomirov@239: /**
tikhomirov@239: * Provides access to sub-repositories defined in this repository. Enumerated sub-repositories are those directly
tikhomirov@239: * known, not recursive collection of all nested sub-repositories.
tikhomirov@239: * @return list of all known sub-repositories in this repository, or empty list if none found.
tikhomirov@482: * @throws HgRuntimeException subclass thereof to indicate issues with the library. Runtime exception
tikhomirov@239: */
tikhomirov@348: public Listnull
tikhomirov@579: */
tikhomirov@331: public HgRepoConfig getConfiguration() /* XXX throws HgInvalidControlFileException? Description of the exception suggests it is only for files under ./hg/*/ {
tikhomirov@331: if (repoConfig == null) {
tikhomirov@331: try {
tikhomirov@490: ConfigFile configFile = impl.readConfiguration();
tikhomirov@331: repoConfig = new HgRepoConfig(configFile);
tikhomirov@331: } catch (IOException ex) {
tikhomirov@331: String m = "Errors while reading user configuration file";
tikhomirov@490: getSessionContext().getLog().dump(getClass(), Warn, ex, m);
tikhomirov@490: return new HgRepoConfig(new ConfigFile(getSessionContext())); // empty config, do not cache, allow to try once again
tikhomirov@331: //throw new HgInvalidControlFileException(m, ex, null);
tikhomirov@331: }
tikhomirov@331: }
tikhomirov@331: return repoConfig;
tikhomirov@331: }
tikhomirov@331:
tikhomirov@526: // There seem to be no cases when access to HgDirstate is required from outside
tikhomirov@526: // (guess, working dir/revision walkers may hide dirstate access and no public visibility needed)
tikhomirov@431: /*package-local*/ final HgDirstate loadDirstate(Path.Source pathFactory) throws HgInvalidControlFileException {
tikhomirov@292: PathRewrite canonicalPath = null;
tikhomirov@388: if (!impl.isCaseSensitiveFileSystem()) {
tikhomirov@292: canonicalPath = new PathRewrite() {
tikhomirov@292:
tikhomirov@292: public CharSequence rewrite(CharSequence path) {
tikhomirov@292: return path.toString().toLowerCase();
tikhomirov@292: }
tikhomirov@292: };
tikhomirov@292: }
tikhomirov@490: HgDirstate ds = new HgDirstate(impl, pathFactory, canonicalPath);
tikhomirov@490: ds.read();
tikhomirov@348: return ds;
tikhomirov@74: }
tikhomirov@74:
tikhomirov@289: /**
tikhomirov@289: * Access to configured set of ignored files.
tikhomirov@289: * @see HgIgnore#isIgnored(Path)
tikhomirov@482: * @throws HgRuntimeException subclass thereof to indicate issues with the library. Runtime exception
tikhomirov@289: */
tikhomirov@482: public HgIgnore getIgnore() throws HgInvalidControlFileException {
tikhomirov@91: // TODO read config for additional locations
tikhomirov@91: if (ignore == null) {
tikhomirov@409: ignore = new HgIgnore(getToRepoPathHelper());
tikhomirov@610: ignore.read(impl);
tikhomirov@610: } else {
tikhomirov@610: ignore.reloadIfChanged(impl);
tikhomirov@91: }
tikhomirov@91: return ignore;
tikhomirov@74: }
tikhomirov@482:
tikhomirov@481: /**
tikhomirov@481: * Mercurial saves message user has supplied for a commit to facilitate message re-use in case commit fails.
tikhomirov@481: * This method provides this saved message.
tikhomirov@481: *
tikhomirov@481: * @return message used for last commit attempt, or null if none
tikhomirov@482: * @throws HgRuntimeException subclass thereof to indicate issues with the library. Runtime exception
tikhomirov@481: */
tikhomirov@482: public String getCommitLastMessage() throws HgInvalidControlFileException {
tikhomirov@490: File lastMessage = impl.getFileFromRepoDir(LastMessage.getPath());
tikhomirov@481: if (!lastMessage.canRead()) {
tikhomirov@481: return null;
tikhomirov@481: }
tikhomirov@481: FileReader fr = null;
tikhomirov@481: try {
tikhomirov@481: fr = new FileReader(lastMessage);
tikhomirov@481: CharBuffer cb = CharBuffer.allocate(Internals.ltoi(lastMessage.length()));
tikhomirov@481: fr.read(cb);
tikhomirov@481: return cb.flip().toString();
tikhomirov@481: } catch (IOException ex) {
tikhomirov@481: throw new HgInvalidControlFileException("Can't retrieve message of last commit attempt", ex, lastMessage);
tikhomirov@481: } finally {
tikhomirov@481: if (fr != null) {
tikhomirov@481: try {
tikhomirov@481: fr.close();
tikhomirov@481: } catch (IOException ex) {
tikhomirov@490: getSessionContext().getLog().dump(getClass(), Warn, "Failed to close %s after read", lastMessage);
tikhomirov@481: }
tikhomirov@481: }
tikhomirov@481: }
tikhomirov@481: }
tikhomirov@486:
tikhomirov@486: /**
tikhomirov@486: * Access repository lock that covers non-store parts of the repository (dirstate, branches, etc -
tikhomirov@486: * everything that has to do with working directory state).
tikhomirov@486: *
tikhomirov@486: * Note, the lock object returned merely gives access to lock mechanism. NO ACTUAL LOCKING IS DONE.
tikhomirov@487: * Use {@link HgRepositoryLock#acquire()} to actually lock the repository.
tikhomirov@486: *
tikhomirov@486: * @return lock object, never null
tikhomirov@486: */
tikhomirov@487: public HgRepositoryLock getWorkingDirLock() {
tikhomirov@486: if (wdLock == null) {
tikhomirov@487: int timeout = getLockTimeout();
tikhomirov@490: File lf = impl.getFileFromRepoDir("wlock");
tikhomirov@486: synchronized (this) {
tikhomirov@486: if (wdLock == null) {
tikhomirov@488: wdLock = new HgRepositoryLock(lf, timeout);
tikhomirov@486: }
tikhomirov@486: }
tikhomirov@486: }
tikhomirov@486: return wdLock;
tikhomirov@486: }
tikhomirov@486:
tikhomirov@613: /**
tikhomirov@613: * Access repository lock that covers repository intrinsic files, unrelated to
tikhomirov@613: * the state of working directory
tikhomirov@613: * @return lock object, never null
tikhomirov@613: */
tikhomirov@487: public HgRepositoryLock getStoreLock() {
tikhomirov@486: if (storeLock == null) {
tikhomirov@487: int timeout = getLockTimeout();
tikhomirov@493: File fl = impl.getFileFromStoreDir("lock");
tikhomirov@486: synchronized (this) {
tikhomirov@486: if (storeLock == null) {
tikhomirov@488: storeLock = new HgRepositoryLock(fl, timeout);
tikhomirov@486: }
tikhomirov@486: }
tikhomirov@486: }
tikhomirov@486: return storeLock;
tikhomirov@486: }
tikhomirov@486:
tikhomirov@484: /**
tikhomirov@484: * Access bookmarks-related functionality
tikhomirov@484: * @return facility to manage bookmarks, never null
tikhomirov@484: * @throws HgRuntimeException subclass thereof to indicate issues with the library. Runtime exception
tikhomirov@484: */
tikhomirov@484: public HgBookmarks getBookmarks() throws HgInvalidControlFileException {
tikhomirov@484: if (bookmarks == null) {
tikhomirov@490: bookmarks = new HgBookmarks(impl);
tikhomirov@484: bookmarks.read();
tikhomirov@610: } else {
tikhomirov@610: bookmarks.reloadIfChanged();
tikhomirov@484: }
tikhomirov@484: return bookmarks;
tikhomirov@484: }
tikhomirov@501:
tikhomirov@501: public HgExtensionsManager getExtensions() {
tikhomirov@501: if (extManager == null) {
tikhomirov@501: class EM extends HgExtensionsManager {
tikhomirov@501: EM() {
tikhomirov@501: super(HgRepository.this.getImplHelper());
tikhomirov@501: }
tikhomirov@501: }
tikhomirov@501: extManager = new EM();
tikhomirov@501: }
tikhomirov@501: return extManager;
tikhomirov@501: }
tikhomirov@74:
tikhomirov@490: /**
tikhomirov@490: * @return session environment of the repository
tikhomirov@490: */
tikhomirov@490: public SessionContext getSessionContext() {
tikhomirov@490: return sessionContext;
tikhomirov@74: }
tikhomirov@114:
tikhomirov@114: /*package-local*/ List