123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860 |
- /*
- * Copyright (C) 2008, Shawn O. Pearce <spearce@spearce.org>
- * Copyright (C) 2010, Christian Halstrick <christian.halstrick@sap.com>
- * Copyright (C) 2010, Matthias Sohn <matthias.sohn@sap.com>
- * and other copyright owners as documented in the project's IP log.
- *
- * This program and the accompanying materials are made available
- * under the terms of the Eclipse Distribution License v1.0 which
- * accompanies this distribution, is reproduced below, and is
- * available at http://www.eclipse.org/org/documents/edl-v10.php
- *
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or
- * without modification, are permitted provided that the following
- * conditions are met:
- *
- * - Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- *
- * - Redistributions in binary form must reproduce the above
- * copyright notice, this list of conditions and the following
- * disclaimer in the documentation and/or other materials provided
- * with the distribution.
- *
- * - Neither the name of the Eclipse Foundation, Inc. nor the
- * names of its contributors may be used to endorse or promote
- * products derived from this software without specific prior
- * written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
- * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
- * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
- * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
- * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
- * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
- * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
- * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
- * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
- * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
- * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
-
- package org.eclipse.jgit.treewalk;
-
- import java.io.ByteArrayInputStream;
- import java.io.File;
- import java.io.FileInputStream;
- import java.io.IOException;
- import java.io.InputStream;
- import java.nio.ByteBuffer;
- import java.nio.CharBuffer;
- import java.nio.charset.CharacterCodingException;
- import java.nio.charset.CharsetEncoder;
- import java.security.MessageDigest;
- import java.text.MessageFormat;
- import java.util.Arrays;
- import java.util.Collections;
- import java.util.Comparator;
-
- import org.eclipse.jgit.JGitText;
- import org.eclipse.jgit.diff.RawText;
- import org.eclipse.jgit.dircache.DirCache;
- import org.eclipse.jgit.dircache.DirCacheEntry;
- import org.eclipse.jgit.errors.CorruptObjectException;
- import org.eclipse.jgit.ignore.IgnoreNode;
- import org.eclipse.jgit.ignore.IgnoreRule;
- import org.eclipse.jgit.lib.Constants;
- import org.eclipse.jgit.lib.FileMode;
- import org.eclipse.jgit.lib.Repository;
- import org.eclipse.jgit.util.FS;
- import org.eclipse.jgit.util.IO;
- import org.eclipse.jgit.util.io.EolCanonicalizingInputStream;
-
- /**
- * Walks a working directory tree as part of a {@link TreeWalk}.
- * <p>
- * Most applications will want to use the standard implementation of this
- * iterator, {@link FileTreeIterator}, as that does all IO through the standard
- * <code>java.io</code> package. Plugins for a Java based IDE may however wish
- * to create their own implementations of this class to allow traversal of the
- * IDE's project space, as well as benefit from any caching the IDE may have.
- *
- * @see FileTreeIterator
- */
- public abstract class WorkingTreeIterator extends AbstractTreeIterator {
- /** An empty entry array, suitable for {@link #init(Entry[])}. */
- protected static final Entry[] EOF = {};
-
- /** Size we perform file IO in if we have to read and hash a file. */
- private static final int BUFFER_SIZE = 2048;
-
- /**
- * Maximum size of files which may be read fully into memory for performance
- * reasons.
- */
- private static final long MAXIMUM_FILE_SIZE_TO_READ_FULLY = 65536;
-
- /** The {@link #idBuffer()} for the current entry. */
- private byte[] contentId;
-
- /** Index within {@link #entries} that {@link #contentId} came from. */
- private int contentIdFromPtr;
-
- /** Buffer used to perform {@link #contentId} computations. */
- private byte[] contentReadBuffer;
-
- /** Digest computer for {@link #contentId} computations. */
- private MessageDigest contentDigest;
-
- /** File name character encoder. */
- private final CharsetEncoder nameEncoder;
-
- /** List of entries obtained from the subclass. */
- private Entry[] entries;
-
- /** Total number of entries in {@link #entries} that are valid. */
- private int entryCnt;
-
- /** Current position within {@link #entries}. */
- private int ptr;
-
- /** If there is a .gitignore file present, the parsed rules from it. */
- private IgnoreNode ignoreNode;
-
- /** Options used to process the working tree. */
- private final WorkingTreeOptions options;
-
- /**
- * Create a new iterator with no parent.
- *
- * @param options
- * working tree options to be used
- */
- protected WorkingTreeIterator(WorkingTreeOptions options) {
- super();
- nameEncoder = Constants.CHARSET.newEncoder();
- this.options = options;
- }
-
- /**
- * Create a new iterator with no parent and a prefix.
- * <p>
- * The prefix path supplied is inserted in front of all paths generated by
- * this iterator. It is intended to be used when an iterator is being
- * created for a subsection of an overall repository and needs to be
- * combined with other iterators that are created to run over the entire
- * repository namespace.
- *
- * @param prefix
- * position of this iterator in the repository tree. The value
- * may be null or the empty string to indicate the prefix is the
- * root of the repository. A trailing slash ('/') is
- * automatically appended if the prefix does not end in '/'.
- * @param options
- * working tree options to be used
- */
- protected WorkingTreeIterator(final String prefix,
- WorkingTreeOptions options) {
- super(prefix);
- nameEncoder = Constants.CHARSET.newEncoder();
- this.options = options;
- }
-
- /**
- * Create an iterator for a subtree of an existing iterator.
- *
- * @param p
- * parent tree iterator.
- */
- protected WorkingTreeIterator(final WorkingTreeIterator p) {
- super(p);
- nameEncoder = p.nameEncoder;
- options = p.options;
- }
-
- /**
- * Initialize this iterator for the root level of a repository.
- * <p>
- * This method should only be invoked after calling {@link #init(Entry[])},
- * and only for the root iterator.
- *
- * @param repo
- * the repository.
- */
- protected void initRootIterator(Repository repo) {
- Entry entry;
- if (ignoreNode instanceof PerDirectoryIgnoreNode)
- entry = ((PerDirectoryIgnoreNode) ignoreNode).entry;
- else
- entry = null;
- ignoreNode = new RootIgnoreNode(entry, repo);
- }
-
- @Override
- public boolean hasId() {
- if (contentIdFromPtr == ptr)
- return true;
- return (mode & FileMode.TYPE_MASK) == FileMode.TYPE_FILE;
- }
-
- @Override
- public byte[] idBuffer() {
- if (contentIdFromPtr == ptr)
- return contentId;
- switch (mode & FileMode.TYPE_MASK) {
- case FileMode.TYPE_FILE:
- contentIdFromPtr = ptr;
- return contentId = idBufferBlob(entries[ptr]);
- case FileMode.TYPE_SYMLINK:
- // Java does not support symbolic links, so we should not
- // have reached this particular part of the walk code.
- //
- return zeroid;
- case FileMode.TYPE_GITLINK:
- // TODO: Support obtaining current HEAD SHA-1 from nested repository
- //
- return zeroid;
- }
- return zeroid;
- }
-
- private void initializeDigestAndReadBuffer() {
- if (contentDigest != null)
- return;
-
- if (parent == null) {
- contentReadBuffer = new byte[BUFFER_SIZE];
- contentDigest = Constants.newMessageDigest();
- } else {
- final WorkingTreeIterator p = (WorkingTreeIterator) parent;
- p.initializeDigestAndReadBuffer();
- contentReadBuffer = p.contentReadBuffer;
- contentDigest = p.contentDigest;
- }
- }
-
- private static final byte[] digits = { '0', '1', '2', '3', '4', '5', '6',
- '7', '8', '9' };
-
- private static final byte[] hblob = Constants
- .encodedTypeString(Constants.OBJ_BLOB);
-
- private byte[] idBufferBlob(final Entry e) {
- try {
- final InputStream is = e.openInputStream();
- if (is == null)
- return zeroid;
- try {
- initializeDigestAndReadBuffer();
-
- final long len = e.getLength();
- if (!mightNeedCleaning(e))
- return computeHash(is, len);
-
- if (len <= MAXIMUM_FILE_SIZE_TO_READ_FULLY) {
- ByteBuffer rawbuf = IO.readWholeStream(is, (int) len);
- byte[] raw = rawbuf.array();
- int n = rawbuf.limit();
- if (!isBinary(e, raw, n)) {
- rawbuf = filterClean(e, raw, n);
- raw = rawbuf.array();
- n = rawbuf.limit();
- }
- return computeHash(new ByteArrayInputStream(raw, 0, n), n);
- }
-
- if (isBinary(e))
- return computeHash(is, len);
-
- final long canonLen;
- final InputStream lenIs = filterClean(e, e.openInputStream());
- try {
- canonLen = computeLength(lenIs);
- } finally {
- safeClose(lenIs);
- }
-
- return computeHash(filterClean(e, is), canonLen);
- } finally {
- safeClose(is);
- }
- } catch (IOException err) {
- // Can't read the file? Don't report the failure either.
- return zeroid;
- }
- }
-
- private static void safeClose(final InputStream in) {
- try {
- in.close();
- } catch (IOException err2) {
- // Suppress any error related to closing an input
- // stream. We don't care, we should not have any
- // outstanding data to flush or anything like that.
- }
- }
-
- private boolean mightNeedCleaning(Entry entry) {
- switch (options.getAutoCRLF()) {
- case FALSE:
- default:
- return false;
-
- case TRUE:
- case INPUT:
- return true;
- }
- }
-
- private boolean isBinary(Entry entry, byte[] content, int sz) {
- return RawText.isBinary(content, sz);
- }
-
- private boolean isBinary(Entry entry) throws IOException {
- InputStream in = entry.openInputStream();
- try {
- return RawText.isBinary(in);
- } finally {
- safeClose(in);
- }
- }
-
- private ByteBuffer filterClean(Entry entry, byte[] src, int n)
- throws IOException {
- InputStream in = new ByteArrayInputStream(src);
- return IO.readWholeStream(filterClean(entry, in), n);
- }
-
- private InputStream filterClean(Entry entry, InputStream in) {
- return new EolCanonicalizingInputStream(in);
- }
-
- /**
- * Returns the working tree options used by this iterator.
- *
- * @return working tree options
- */
- public WorkingTreeOptions getOptions() {
- return options;
- }
-
- @Override
- public int idOffset() {
- return 0;
- }
-
- @Override
- public void reset() {
- if (!first()) {
- ptr = 0;
- if (!eof())
- parseEntry();
- }
- }
-
- @Override
- public boolean first() {
- return ptr == 0;
- }
-
- @Override
- public boolean eof() {
- return ptr == entryCnt;
- }
-
- @Override
- public void next(final int delta) throws CorruptObjectException {
- ptr += delta;
- if (!eof())
- parseEntry();
- }
-
- @Override
- public void back(final int delta) throws CorruptObjectException {
- ptr -= delta;
- parseEntry();
- }
-
- private void parseEntry() {
- final Entry e = entries[ptr];
- mode = e.getMode().getBits();
-
- final int nameLen = e.encodedNameLen;
- ensurePathCapacity(pathOffset + nameLen, pathOffset);
- System.arraycopy(e.encodedName, 0, path, pathOffset, nameLen);
- pathLen = pathOffset + nameLen;
- }
-
- /**
- * Get the byte length of this entry.
- *
- * @return size of this file, in bytes.
- */
- public long getEntryLength() {
- return current().getLength();
- }
-
- /**
- * Get the last modified time of this entry.
- *
- * @return last modified time of this file, in milliseconds since the epoch
- * (Jan 1, 1970 UTC).
- */
- public long getEntryLastModified() {
- return current().getLastModified();
- }
-
- /**
- * Obtain an input stream to read the file content.
- * <p>
- * Efficient implementations are not required. The caller will usually
- * obtain the stream only once per entry, if at all.
- * <p>
- * The input stream should not use buffering if the implementation can avoid
- * it. The caller will buffer as necessary to perform efficient block IO
- * operations.
- * <p>
- * The caller will close the stream once complete.
- *
- * @return a stream to read from the file.
- * @throws IOException
- * the file could not be opened for reading.
- */
- public InputStream openEntryStream() throws IOException {
- return current().openInputStream();
- }
-
- /**
- * Determine if the current entry path is ignored by an ignore rule.
- *
- * @return true if the entry was ignored by an ignore rule file.
- * @throws IOException
- * a relevant ignore rule file exists but cannot be read.
- */
- public boolean isEntryIgnored() throws IOException {
- return isEntryIgnored(pathLen);
- }
-
- /**
- * Determine if the entry path is ignored by an ignore rule.
- *
- * @param pLen
- * the length of the path in the path buffer.
- * @return true if the entry is ignored by an ignore rule.
- * @throws IOException
- * a relevant ignore rule file exists but cannot be read.
- */
- protected boolean isEntryIgnored(final int pLen) throws IOException {
- IgnoreNode rules = getIgnoreNode();
- if (rules != null) {
- // The ignore code wants path to start with a '/' if possible.
- // If we have the '/' in our path buffer because we are inside
- // a subdirectory include it in the range we convert to string.
- //
- int pOff = pathOffset;
- if (0 < pOff)
- pOff--;
- String p = TreeWalk.pathOf(path, pOff, pLen);
- switch (rules.isIgnored(p, FileMode.TREE.equals(mode))) {
- case IGNORED:
- return true;
- case NOT_IGNORED:
- return false;
- case CHECK_PARENT:
- break;
- }
- }
- if (parent instanceof WorkingTreeIterator)
- return ((WorkingTreeIterator) parent).isEntryIgnored(pLen);
- return false;
- }
-
- private IgnoreNode getIgnoreNode() throws IOException {
- if (ignoreNode instanceof PerDirectoryIgnoreNode)
- ignoreNode = ((PerDirectoryIgnoreNode) ignoreNode).load();
- return ignoreNode;
- }
-
- private static final Comparator<Entry> ENTRY_CMP = new Comparator<Entry>() {
- public int compare(final Entry o1, final Entry o2) {
- final byte[] a = o1.encodedName;
- final byte[] b = o2.encodedName;
- final int aLen = o1.encodedNameLen;
- final int bLen = o2.encodedNameLen;
- int cPos;
-
- for (cPos = 0; cPos < aLen && cPos < bLen; cPos++) {
- final int cmp = (a[cPos] & 0xff) - (b[cPos] & 0xff);
- if (cmp != 0)
- return cmp;
- }
-
- if (cPos < aLen)
- return (a[cPos] & 0xff) - lastPathChar(o2);
- if (cPos < bLen)
- return lastPathChar(o1) - (b[cPos] & 0xff);
- return lastPathChar(o1) - lastPathChar(o2);
- }
- };
-
- static int lastPathChar(final Entry e) {
- return e.getMode() == FileMode.TREE ? '/' : '\0';
- }
-
- /**
- * Constructor helper.
- *
- * @param list
- * files in the subtree of the work tree this iterator operates
- * on
- */
- protected void init(final Entry[] list) {
- // Filter out nulls, . and .. as these are not valid tree entries,
- // also cache the encoded forms of the path names for efficient use
- // later on during sorting and iteration.
- //
- entries = list;
- int i, o;
-
- for (i = 0, o = 0; i < entries.length; i++) {
- final Entry e = entries[i];
- if (e == null)
- continue;
- final String name = e.getName();
- if (".".equals(name) || "..".equals(name))
- continue;
- if (Constants.DOT_GIT.equals(name))
- continue;
- if (Constants.DOT_GIT_IGNORE.equals(name))
- ignoreNode = new PerDirectoryIgnoreNode(e);
- if (i != o)
- entries[o] = e;
- e.encodeName(nameEncoder);
- o++;
- }
- entryCnt = o;
- Arrays.sort(entries, 0, entryCnt, ENTRY_CMP);
-
- contentIdFromPtr = -1;
- ptr = 0;
- if (!eof())
- parseEntry();
- }
-
- /**
- * Obtain the current entry from this iterator.
- *
- * @return the currently selected entry.
- */
- protected Entry current() {
- return entries[ptr];
- }
-
- /**
- * Checks whether this entry differs from a given entry from the
- * {@link DirCache}.
- *
- * File status information is used and if status is same we consider the
- * file identical to the state in the working directory. Native git uses
- * more stat fields than we have accessible in Java.
- *
- * @param entry
- * the entry from the dircache we want to compare against
- * @param forceContentCheck
- * True if the actual file content should be checked if
- * modification time differs.
- * @param checkFilemode
- * whether the executable-bit in the filemode should be checked
- * to detect modifications
- * @param fs
- * The filesystem this repo uses. Needed to find out whether the
- * executable-bits are supported
- *
- * @return true if content is most likely different.
- */
- public boolean isModified(DirCacheEntry entry, boolean forceContentCheck,
- boolean checkFilemode, FS fs) {
- if (entry.isAssumeValid())
- return false;
-
- if (entry.isUpdateNeeded())
- return true;
-
- if (!entry.isSmudged() && (getEntryLength() != entry.getLength()))
- return true;
-
- // Determine difference in mode-bits of file and index-entry. In the
- // bitwise presentation of modeDiff we'll have a '1' when the two modes
- // differ at this position.
- int modeDiff = getEntryRawMode() ^ entry.getRawMode();
- // Ignore the executable file bits if checkFilemode tells me to do so.
- // Ignoring is done by setting the bits representing a EXECUTABLE_FILE
- // to '0' in modeDiff
- if (!checkFilemode)
- modeDiff &= ~FileMode.EXECUTABLE_FILE.getBits();
- if (modeDiff != 0)
- // Report a modification if the modes still (after potentially
- // ignoring EXECUTABLE_FILE bits) differ
- return true;
-
- // Git under windows only stores seconds so we round the timestamp
- // Java gives us if it looks like the timestamp in index is seconds
- // only. Otherwise we compare the timestamp at millisecond precision.
- long cacheLastModified = entry.getLastModified();
- long fileLastModified = getEntryLastModified();
- if (cacheLastModified % 1000 == 0)
- fileLastModified = fileLastModified - fileLastModified % 1000;
-
- if (fileLastModified != cacheLastModified) {
- // The file is dirty by timestamps
- if (forceContentCheck) {
- // But we are told to look at content even though timestamps
- // tell us about modification
- return contentCheck(entry);
- } else {
- // We are told to assume a modification if timestamps differs
- return true;
- }
- } else {
- // The file is clean when you look at timestamps.
- if (entry.isSmudged()) {
- // The file is clean by timestamps but the entry was smudged.
- // Lets do a content check
- return contentCheck(entry);
- } else {
- // The file is clean by timestamps and the entry is not
- // smudged: Can't get any cleaner!
- return false;
- }
- }
- }
-
- /**
- * Compares the entries content with the content in the filesystem.
- * Unsmudges the entry when it is detected that it is clean.
- *
- * @param entry
- * the entry to be checked
- * @return <code>true</code> if the content matches, <code>false</code>
- * otherwise
- */
- private boolean contentCheck(DirCacheEntry entry) {
- if (getEntryObjectId().equals(entry.getObjectId())) {
- // Content has not changed
-
- // We know the entry can't be racily clean because it's still clean.
- // Therefore we unsmudge the entry!
- // If by any chance we now unsmudge although we are still in the
- // same time-slot as the last modification to the index file the
- // next index write operation will smudge again.
- // Caution: we are unsmudging just by setting the length of the
- // in-memory entry object. It's the callers task to detect that we
- // have modified the entry and to persist the modified index.
- entry.setLength((int) getEntryLength());
-
- return false;
- } else {
- // Content differs: that's a real change!
- return true;
- }
- }
-
- private long computeLength(InputStream in) throws IOException {
- // Since we only care about the length, use skip. The stream
- // may be able to more efficiently wade through its data.
- //
- long length = 0;
- for (;;) {
- long n = in.skip(1 << 20);
- if (n <= 0)
- break;
- length += n;
- }
- return length;
- }
-
- private byte[] computeHash(InputStream in, long length) throws IOException {
- contentDigest.reset();
- contentDigest.update(hblob);
- contentDigest.update((byte) ' ');
-
- long sz = length;
- if (sz == 0) {
- contentDigest.update((byte) '0');
- } else {
- final int bufn = contentReadBuffer.length;
- int p = bufn;
- do {
- contentReadBuffer[--p] = digits[(int) (sz % 10)];
- sz /= 10;
- } while (sz > 0);
- contentDigest.update(contentReadBuffer, p, bufn - p);
- }
- contentDigest.update((byte) 0);
-
- for (;;) {
- final int r = in.read(contentReadBuffer);
- if (r <= 0)
- break;
- contentDigest.update(contentReadBuffer, 0, r);
- sz += r;
- }
- if (sz != length)
- return zeroid;
- return contentDigest.digest();
- }
-
- /** A single entry within a working directory tree. */
- protected static abstract class Entry {
- byte[] encodedName;
-
- int encodedNameLen;
-
- void encodeName(final CharsetEncoder enc) {
- final ByteBuffer b;
- try {
- b = enc.encode(CharBuffer.wrap(getName()));
- } catch (CharacterCodingException e) {
- // This should so never happen.
- throw new RuntimeException(MessageFormat.format(
- JGitText.get().unencodeableFile, getName()));
- }
-
- encodedNameLen = b.limit();
- if (b.hasArray() && b.arrayOffset() == 0)
- encodedName = b.array();
- else
- b.get(encodedName = new byte[encodedNameLen]);
- }
-
- public String toString() {
- return getMode().toString() + " " + getName();
- }
-
- /**
- * Get the type of this entry.
- * <p>
- * <b>Note: Efficient implementation required.</b>
- * <p>
- * The implementation of this method must be efficient. If a subclass
- * needs to compute the value they should cache the reference within an
- * instance member instead.
- *
- * @return a file mode constant from {@link FileMode}.
- */
- public abstract FileMode getMode();
-
- /**
- * Get the byte length of this entry.
- * <p>
- * <b>Note: Efficient implementation required.</b>
- * <p>
- * The implementation of this method must be efficient. If a subclass
- * needs to compute the value they should cache the reference within an
- * instance member instead.
- *
- * @return size of this file, in bytes.
- */
- public abstract long getLength();
-
- /**
- * Get the last modified time of this entry.
- * <p>
- * <b>Note: Efficient implementation required.</b>
- * <p>
- * The implementation of this method must be efficient. If a subclass
- * needs to compute the value they should cache the reference within an
- * instance member instead.
- *
- * @return time since the epoch (in ms) of the last change.
- */
- public abstract long getLastModified();
-
- /**
- * Get the name of this entry within its directory.
- * <p>
- * Efficient implementations are not required. The caller will obtain
- * the name only once and cache it once obtained.
- *
- * @return name of the entry.
- */
- public abstract String getName();
-
- /**
- * Obtain an input stream to read the file content.
- * <p>
- * Efficient implementations are not required. The caller will usually
- * obtain the stream only once per entry, if at all.
- * <p>
- * The input stream should not use buffering if the implementation can
- * avoid it. The caller will buffer as necessary to perform efficient
- * block IO operations.
- * <p>
- * The caller will close the stream once complete.
- *
- * @return a stream to read from the file.
- * @throws IOException
- * the file could not be opened for reading.
- */
- public abstract InputStream openInputStream() throws IOException;
- }
-
- /** Magic type indicating we know rules exist, but they aren't loaded. */
- private static class PerDirectoryIgnoreNode extends IgnoreNode {
- final Entry entry;
-
- PerDirectoryIgnoreNode(Entry entry) {
- super(Collections.<IgnoreRule> emptyList());
- this.entry = entry;
- }
-
- IgnoreNode load() throws IOException {
- IgnoreNode r = new IgnoreNode();
- InputStream in = entry.openInputStream();
- try {
- r.parse(in);
- } finally {
- in.close();
- }
- return r.getRules().isEmpty() ? null : r;
- }
- }
-
- /** Magic type indicating there may be rules for the top level. */
- private static class RootIgnoreNode extends PerDirectoryIgnoreNode {
- final Repository repository;
-
- RootIgnoreNode(Entry entry, Repository repository) {
- super(entry);
- this.repository = repository;
- }
-
- @Override
- IgnoreNode load() throws IOException {
- IgnoreNode r;
- if (entry != null) {
- r = super.load();
- if (r == null)
- r = new IgnoreNode();
- } else {
- r = new IgnoreNode();
- }
-
- File exclude = new File(repository.getDirectory(), "info/exclude");
- if (exclude.exists()) {
- FileInputStream in = new FileInputStream(exclude);
- try {
- r.parse(in);
- } finally {
- in.close();
- }
- }
-
- return r.getRules().isEmpty() ? null : r;
- }
- }
- }
|