You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

DirCacheEntry.java 23KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755
  1. /*
  2. * Copyright (C) 2008-2009, Google Inc.
  3. * Copyright (C) 2008, Shawn O. Pearce <spearce@spearce.org>
  4. * Copyright (C) 2010, Matthias Sohn <matthias.sohn@sap.com>
  5. * Copyright (C) 2010, Christian Halstrick <christian.halstrick@sap.com>
  6. * and other copyright owners as documented in the project's IP log.
  7. *
  8. * This program and the accompanying materials are made available
  9. * under the terms of the Eclipse Distribution License v1.0 which
  10. * accompanies this distribution, is reproduced below, and is
  11. * available at http://www.eclipse.org/org/documents/edl-v10.php
  12. *
  13. * All rights reserved.
  14. *
  15. * Redistribution and use in source and binary forms, with or
  16. * without modification, are permitted provided that the following
  17. * conditions are met:
  18. *
  19. * - Redistributions of source code must retain the above copyright
  20. * notice, this list of conditions and the following disclaimer.
  21. *
  22. * - Redistributions in binary form must reproduce the above
  23. * copyright notice, this list of conditions and the following
  24. * disclaimer in the documentation and/or other materials provided
  25. * with the distribution.
  26. *
  27. * - Neither the name of the Eclipse Foundation, Inc. nor the
  28. * names of its contributors may be used to endorse or promote
  29. * products derived from this software without specific prior
  30. * written permission.
  31. *
  32. * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
  33. * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
  34. * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  35. * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  36. * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  37. * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  38. * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  39. * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  40. * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  41. * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  42. * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  43. * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  44. * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  45. */
  46. package org.eclipse.jgit.dircache;
  47. import java.io.ByteArrayOutputStream;
  48. import java.io.EOFException;
  49. import java.io.IOException;
  50. import java.io.InputStream;
  51. import java.io.OutputStream;
  52. import java.nio.ByteBuffer;
  53. import java.security.MessageDigest;
  54. import java.text.MessageFormat;
  55. import java.util.Arrays;
  56. import org.eclipse.jgit.errors.CorruptObjectException;
  57. import org.eclipse.jgit.internal.JGitText;
  58. import org.eclipse.jgit.lib.AnyObjectId;
  59. import org.eclipse.jgit.lib.Constants;
  60. import org.eclipse.jgit.lib.FileMode;
  61. import org.eclipse.jgit.lib.ObjectId;
  62. import org.eclipse.jgit.util.IO;
  63. import org.eclipse.jgit.util.MutableInteger;
  64. import org.eclipse.jgit.util.NB;
  65. import org.eclipse.jgit.util.SystemReader;
  66. /**
  67. * A single file (or stage of a file) in a {@link DirCache}.
  68. * <p>
  69. * An entry represents exactly one stage of a file. If a file path is unmerged
  70. * then multiple DirCacheEntry instances may appear for the same path name.
  71. */
  72. public class DirCacheEntry {
  73. private static final byte[] nullpad = new byte[8];
  74. /** The standard (fully merged) stage for an entry. */
  75. public static final int STAGE_0 = 0;
  76. /** The base tree revision for an entry. */
  77. public static final int STAGE_1 = 1;
  78. /** The first tree revision (usually called "ours"). */
  79. public static final int STAGE_2 = 2;
  80. /** The second tree revision (usually called "theirs"). */
  81. public static final int STAGE_3 = 3;
  82. private static final int P_CTIME = 0;
  83. // private static final int P_CTIME_NSEC = 4;
  84. private static final int P_MTIME = 8;
  85. // private static final int P_MTIME_NSEC = 12;
  86. // private static final int P_DEV = 16;
  87. // private static final int P_INO = 20;
  88. private static final int P_MODE = 24;
  89. // private static final int P_UID = 28;
  90. // private static final int P_GID = 32;
  91. private static final int P_SIZE = 36;
  92. private static final int P_OBJECTID = 40;
  93. private static final int P_FLAGS = 60;
  94. private static final int P_FLAGS2 = 62;
  95. /** Mask applied to data in {@link #P_FLAGS} to get the name length. */
  96. private static final int NAME_MASK = 0xfff;
  97. private static final int INTENT_TO_ADD = 0x20000000;
  98. private static final int SKIP_WORKTREE = 0x40000000;
  99. private static final int EXTENDED_FLAGS = (INTENT_TO_ADD | SKIP_WORKTREE);
  100. private static final int INFO_LEN = 62;
  101. private static final int INFO_LEN_EXTENDED = 64;
  102. private static final int EXTENDED = 0x40;
  103. private static final int ASSUME_VALID = 0x80;
  104. /** In-core flag signaling that the entry should be considered as modified. */
  105. private static final int UPDATE_NEEDED = 0x1;
  106. /** (Possibly shared) header information storage. */
  107. private final byte[] info;
  108. /** First location within {@link #info} where our header starts. */
  109. private final int infoOffset;
  110. /** Our encoded path name, from the root of the repository. */
  111. final byte[] path;
  112. /** Flags which are never stored to disk. */
  113. private byte inCoreFlags;
  114. DirCacheEntry(final byte[] sharedInfo, final MutableInteger infoAt,
  115. final InputStream in, final MessageDigest md, final int smudge_s,
  116. final int smudge_ns) throws IOException {
  117. info = sharedInfo;
  118. infoOffset = infoAt.value;
  119. IO.readFully(in, info, infoOffset, INFO_LEN);
  120. final int len;
  121. if (isExtended()) {
  122. len = INFO_LEN_EXTENDED;
  123. IO.readFully(in, info, infoOffset + INFO_LEN, INFO_LEN_EXTENDED - INFO_LEN);
  124. if ((getExtendedFlags() & ~EXTENDED_FLAGS) != 0)
  125. throw new IOException(MessageFormat.format(JGitText.get()
  126. .DIRCUnrecognizedExtendedFlags, String.valueOf(getExtendedFlags())));
  127. } else
  128. len = INFO_LEN;
  129. infoAt.value += len;
  130. md.update(info, infoOffset, len);
  131. int pathLen = NB.decodeUInt16(info, infoOffset + P_FLAGS) & NAME_MASK;
  132. int skipped = 0;
  133. if (pathLen < NAME_MASK) {
  134. path = new byte[pathLen];
  135. IO.readFully(in, path, 0, pathLen);
  136. md.update(path, 0, pathLen);
  137. } else {
  138. final ByteArrayOutputStream tmp = new ByteArrayOutputStream();
  139. {
  140. final byte[] buf = new byte[NAME_MASK];
  141. IO.readFully(in, buf, 0, NAME_MASK);
  142. tmp.write(buf);
  143. }
  144. for (;;) {
  145. final int c = in.read();
  146. if (c < 0)
  147. throw new EOFException(JGitText.get().shortReadOfBlock);
  148. if (c == 0)
  149. break;
  150. tmp.write(c);
  151. }
  152. path = tmp.toByteArray();
  153. pathLen = path.length;
  154. skipped = 1; // we already skipped 1 '\0' above to break the loop.
  155. md.update(path, 0, pathLen);
  156. md.update((byte) 0);
  157. }
  158. try {
  159. checkPath(path);
  160. } catch (InvalidPathException e) {
  161. CorruptObjectException p =
  162. new CorruptObjectException(e.getMessage());
  163. if (e.getCause() != null)
  164. p.initCause(e.getCause());
  165. throw p;
  166. }
  167. // Index records are padded out to the next 8 byte alignment
  168. // for historical reasons related to how C Git read the files.
  169. //
  170. final int actLen = len + pathLen;
  171. final int expLen = (actLen + 8) & ~7;
  172. final int padLen = expLen - actLen - skipped;
  173. if (padLen > 0) {
  174. IO.skipFully(in, padLen);
  175. md.update(nullpad, 0, padLen);
  176. }
  177. if (mightBeRacilyClean(smudge_s, smudge_ns))
  178. smudgeRacilyClean();
  179. }
  180. /**
  181. * Create an empty entry at stage 0.
  182. *
  183. * @param newPath
  184. * name of the cache entry.
  185. * @throws IllegalArgumentException
  186. * If the path starts or ends with "/", or contains "//" either
  187. * "\0". These sequences are not permitted in a git tree object
  188. * or DirCache file.
  189. */
  190. public DirCacheEntry(final String newPath) {
  191. this(Constants.encode(newPath), STAGE_0);
  192. }
  193. /**
  194. * Create an empty entry at the specified stage.
  195. *
  196. * @param newPath
  197. * name of the cache entry.
  198. * @param stage
  199. * the stage index of the new entry.
  200. * @throws IllegalArgumentException
  201. * If the path starts or ends with "/", or contains "//" either
  202. * "\0". These sequences are not permitted in a git tree object
  203. * or DirCache file. Or if {@code stage} is outside of the
  204. * range 0..3, inclusive.
  205. */
  206. public DirCacheEntry(final String newPath, final int stage) {
  207. this(Constants.encode(newPath), stage);
  208. }
  209. /**
  210. * Create an empty entry at stage 0.
  211. *
  212. * @param newPath
  213. * name of the cache entry, in the standard encoding.
  214. * @throws IllegalArgumentException
  215. * If the path starts or ends with "/", or contains "//" either
  216. * "\0". These sequences are not permitted in a git tree object
  217. * or DirCache file.
  218. */
  219. public DirCacheEntry(final byte[] newPath) {
  220. this(newPath, STAGE_0);
  221. }
  222. /**
  223. * Create an empty entry at the specified stage.
  224. *
  225. * @param path
  226. * name of the cache entry, in the standard encoding.
  227. * @param stage
  228. * the stage index of the new entry.
  229. * @throws IllegalArgumentException
  230. * If the path starts or ends with "/", or contains "//" either
  231. * "\0". These sequences are not permitted in a git tree object
  232. * or DirCache file. Or if {@code stage} is outside of the
  233. * range 0..3, inclusive.
  234. */
  235. @SuppressWarnings("boxing")
  236. public DirCacheEntry(byte[] path, final int stage) {
  237. checkPath(path);
  238. if (stage < 0 || 3 < stage)
  239. throw new IllegalArgumentException(MessageFormat.format(
  240. JGitText.get().invalidStageForPath,
  241. stage, toString(path)));
  242. info = new byte[INFO_LEN];
  243. infoOffset = 0;
  244. this.path = path;
  245. int flags = ((stage & 0x3) << 12);
  246. if (path.length < NAME_MASK)
  247. flags |= path.length;
  248. else
  249. flags |= NAME_MASK;
  250. NB.encodeInt16(info, infoOffset + P_FLAGS, flags);
  251. }
  252. void write(final OutputStream os) throws IOException {
  253. final int len = isExtended() ? INFO_LEN_EXTENDED : INFO_LEN;
  254. final int pathLen = path.length;
  255. os.write(info, infoOffset, len);
  256. os.write(path, 0, pathLen);
  257. // Index records are padded out to the next 8 byte alignment
  258. // for historical reasons related to how C Git read the files.
  259. //
  260. final int actLen = len + pathLen;
  261. final int expLen = (actLen + 8) & ~7;
  262. if (actLen != expLen)
  263. os.write(nullpad, 0, expLen - actLen);
  264. }
  265. /**
  266. * Is it possible for this entry to be accidentally assumed clean?
  267. * <p>
  268. * The "racy git" problem happens when a work file can be updated faster
  269. * than the filesystem records file modification timestamps. It is possible
  270. * for an application to edit a work file, update the index, then edit it
  271. * again before the filesystem will give the work file a new modification
  272. * timestamp. This method tests to see if file was written out at the same
  273. * time as the index.
  274. *
  275. * @param smudge_s
  276. * seconds component of the index's last modified time.
  277. * @param smudge_ns
  278. * nanoseconds component of the index's last modified time.
  279. * @return true if extra careful checks should be used.
  280. */
  281. public final boolean mightBeRacilyClean(final int smudge_s, final int smudge_ns) {
  282. // If the index has a modification time then it came from disk
  283. // and was not generated from scratch in memory. In such cases
  284. // the entry is 'racily clean' if the entry's cached modification
  285. // time is equal to or later than the index modification time. In
  286. // such cases the work file is too close to the index to tell if
  287. // it is clean or not based on the modification time alone.
  288. //
  289. final int base = infoOffset + P_MTIME;
  290. final int mtime = NB.decodeInt32(info, base);
  291. if (smudge_s == mtime)
  292. return smudge_ns <= NB.decodeInt32(info, base + 4);
  293. return false;
  294. }
  295. /**
  296. * Force this entry to no longer match its working tree file.
  297. * <p>
  298. * This avoids the "racy git" problem by making this index entry no longer
  299. * match the file in the working directory. Later git will be forced to
  300. * compare the file content to ensure the file matches the working tree.
  301. */
  302. public final void smudgeRacilyClean() {
  303. // To mark an entry racily clean we set its length to 0 (like native git
  304. // does). Entries which are not racily clean and have zero length can be
  305. // distinguished from racily clean entries by checking P_OBJECTID
  306. // against the SHA1 of empty content. When length is 0 and P_OBJECTID is
  307. // different from SHA1 of empty content we know the entry is marked
  308. // racily clean
  309. final int base = infoOffset + P_SIZE;
  310. Arrays.fill(info, base, base + 4, (byte) 0);
  311. }
  312. /**
  313. * Check whether this entry has been smudged or not
  314. * <p>
  315. * If a blob has length 0 we know his id see {@link Constants#EMPTY_BLOB_ID}. If an entry
  316. * has length 0 and an ID different from the one for empty blob we know this
  317. * entry was smudged.
  318. *
  319. * @return <code>true</code> if the entry is smudged, <code>false</code>
  320. * otherwise
  321. */
  322. public final boolean isSmudged() {
  323. final int base = infoOffset + P_OBJECTID;
  324. return (getLength() == 0) && (Constants.EMPTY_BLOB_ID.compareTo(info, base) != 0);
  325. }
  326. final byte[] idBuffer() {
  327. return info;
  328. }
  329. final int idOffset() {
  330. return infoOffset + P_OBJECTID;
  331. }
  332. /**
  333. * Is this entry always thought to be unmodified?
  334. * <p>
  335. * Most entries in the index do not have this flag set. Users may however
  336. * set them on if the file system stat() costs are too high on this working
  337. * directory, such as on NFS or SMB volumes.
  338. *
  339. * @return true if we must assume the entry is unmodified.
  340. */
  341. public boolean isAssumeValid() {
  342. return (info[infoOffset + P_FLAGS] & ASSUME_VALID) != 0;
  343. }
  344. /**
  345. * Set the assume valid flag for this entry,
  346. *
  347. * @param assume
  348. * true to ignore apparent modifications; false to look at last
  349. * modified to detect file modifications.
  350. */
  351. public void setAssumeValid(final boolean assume) {
  352. if (assume)
  353. info[infoOffset + P_FLAGS] |= ASSUME_VALID;
  354. else
  355. info[infoOffset + P_FLAGS] &= ~ASSUME_VALID;
  356. }
  357. /**
  358. * @return true if this entry should be checked for changes
  359. */
  360. public boolean isUpdateNeeded() {
  361. return (inCoreFlags & UPDATE_NEEDED) != 0;
  362. }
  363. /**
  364. * Set whether this entry must be checked for changes
  365. *
  366. * @param updateNeeded
  367. */
  368. public void setUpdateNeeded(boolean updateNeeded) {
  369. if (updateNeeded)
  370. inCoreFlags |= UPDATE_NEEDED;
  371. else
  372. inCoreFlags &= ~UPDATE_NEEDED;
  373. }
  374. /**
  375. * Get the stage of this entry.
  376. * <p>
  377. * Entries have one of 4 possible stages: 0-3.
  378. *
  379. * @return the stage of this entry.
  380. */
  381. public int getStage() {
  382. return (info[infoOffset + P_FLAGS] >>> 4) & 0x3;
  383. }
  384. /**
  385. * Returns whether this entry should be skipped from the working tree.
  386. *
  387. * @return true if this entry should be skipepd.
  388. */
  389. public boolean isSkipWorkTree() {
  390. return (getExtendedFlags() & SKIP_WORKTREE) != 0;
  391. }
  392. /**
  393. * Returns whether this entry is intent to be added to the Index.
  394. *
  395. * @return true if this entry is intent to add.
  396. */
  397. public boolean isIntentToAdd() {
  398. return (getExtendedFlags() & INTENT_TO_ADD) != 0;
  399. }
  400. /**
  401. * Returns whether this entry is in the fully-merged stage (0).
  402. *
  403. * @return true if this entry is merged
  404. * @since 2.2
  405. */
  406. public boolean isMerged() {
  407. return getStage() == STAGE_0;
  408. }
  409. /**
  410. * Obtain the raw {@link FileMode} bits for this entry.
  411. *
  412. * @return mode bits for the entry.
  413. * @see FileMode#fromBits(int)
  414. */
  415. public int getRawMode() {
  416. return NB.decodeInt32(info, infoOffset + P_MODE);
  417. }
  418. /**
  419. * Obtain the {@link FileMode} for this entry.
  420. *
  421. * @return the file mode singleton for this entry.
  422. */
  423. public FileMode getFileMode() {
  424. return FileMode.fromBits(getRawMode());
  425. }
  426. /**
  427. * Set the file mode for this entry.
  428. *
  429. * @param mode
  430. * the new mode constant.
  431. * @throws IllegalArgumentException
  432. * If {@code mode} is {@link FileMode#MISSING},
  433. * {@link FileMode#TREE}, or any other type code not permitted
  434. * in a tree object.
  435. */
  436. public void setFileMode(final FileMode mode) {
  437. switch (mode.getBits() & FileMode.TYPE_MASK) {
  438. case FileMode.TYPE_MISSING:
  439. case FileMode.TYPE_TREE:
  440. throw new IllegalArgumentException(MessageFormat.format(
  441. JGitText.get().invalidModeForPath, mode, getPathString()));
  442. }
  443. NB.encodeInt32(info, infoOffset + P_MODE, mode.getBits());
  444. }
  445. void setFileMode(int mode) {
  446. NB.encodeInt32(info, infoOffset + P_MODE, mode);
  447. }
  448. /**
  449. * Get the cached creation time of this file, in milliseconds.
  450. *
  451. * @return cached creation time of this file, in milliseconds since the
  452. * Java epoch (midnight Jan 1, 1970 UTC).
  453. */
  454. public long getCreationTime() {
  455. return decodeTS(P_CTIME);
  456. }
  457. /**
  458. * Set the cached creation time of this file, using milliseconds.
  459. *
  460. * @param when
  461. * new cached creation time of the file, in milliseconds.
  462. */
  463. public void setCreationTime(final long when) {
  464. encodeTS(P_CTIME, when);
  465. }
  466. /**
  467. * Get the cached last modification date of this file, in milliseconds.
  468. * <p>
  469. * One of the indicators that the file has been modified by an application
  470. * changing the working tree is if the last modification time for the file
  471. * differs from the time stored in this entry.
  472. *
  473. * @return last modification time of this file, in milliseconds since the
  474. * Java epoch (midnight Jan 1, 1970 UTC).
  475. */
  476. public long getLastModified() {
  477. return decodeTS(P_MTIME);
  478. }
  479. /**
  480. * Set the cached last modification date of this file, using milliseconds.
  481. *
  482. * @param when
  483. * new cached modification date of the file, in milliseconds.
  484. */
  485. public void setLastModified(final long when) {
  486. encodeTS(P_MTIME, when);
  487. }
  488. /**
  489. * Get the cached size (mod 4 GB) (in bytes) of this file.
  490. * <p>
  491. * One of the indicators that the file has been modified by an application
  492. * changing the working tree is if the size of the file (in bytes) differs
  493. * from the size stored in this entry.
  494. * <p>
  495. * Note that this is the length of the file in the working directory, which
  496. * may differ from the size of the decompressed blob if work tree filters
  497. * are being used, such as LF&lt;-&gt;CRLF conversion.
  498. * <p>
  499. * Note also that for very large files, this is the size of the on-disk file
  500. * truncated to 32 bits, i.e. modulo 4294967296. If that value is larger
  501. * than 2GB, it will appear negative.
  502. *
  503. * @return cached size of the working directory file, in bytes.
  504. */
  505. public int getLength() {
  506. return NB.decodeInt32(info, infoOffset + P_SIZE);
  507. }
  508. /**
  509. * Set the cached size (in bytes) of this file.
  510. *
  511. * @param sz
  512. * new cached size of the file, as bytes. If the file is larger
  513. * than 2G, cast it to (int) before calling this method.
  514. */
  515. public void setLength(final int sz) {
  516. NB.encodeInt32(info, infoOffset + P_SIZE, sz);
  517. }
  518. /**
  519. * Set the cached size (in bytes) of this file.
  520. *
  521. * @param sz
  522. * new cached size of the file, as bytes.
  523. */
  524. public void setLength(final long sz) {
  525. setLength((int) sz);
  526. }
  527. /**
  528. * Obtain the ObjectId for the entry.
  529. * <p>
  530. * Using this method to compare ObjectId values between entries is
  531. * inefficient as it causes memory allocation.
  532. *
  533. * @return object identifier for the entry.
  534. */
  535. public ObjectId getObjectId() {
  536. return ObjectId.fromRaw(idBuffer(), idOffset());
  537. }
  538. /**
  539. * Set the ObjectId for the entry.
  540. *
  541. * @param id
  542. * new object identifier for the entry. May be
  543. * {@link ObjectId#zeroId()} to remove the current identifier.
  544. */
  545. public void setObjectId(final AnyObjectId id) {
  546. id.copyRawTo(idBuffer(), idOffset());
  547. }
  548. /**
  549. * Set the ObjectId for the entry from the raw binary representation.
  550. *
  551. * @param bs
  552. * the raw byte buffer to read from. At least 20 bytes after p
  553. * must be available within this byte array.
  554. * @param p
  555. * position to read the first byte of data from.
  556. */
  557. public void setObjectIdFromRaw(final byte[] bs, final int p) {
  558. final int n = Constants.OBJECT_ID_LENGTH;
  559. System.arraycopy(bs, p, idBuffer(), idOffset(), n);
  560. }
  561. /**
  562. * Get the entry's complete path.
  563. * <p>
  564. * This method is not very efficient and is primarily meant for debugging
  565. * and final output generation. Applications should try to avoid calling it,
  566. * and if invoked do so only once per interesting entry, where the name is
  567. * absolutely required for correct function.
  568. *
  569. * @return complete path of the entry, from the root of the repository. If
  570. * the entry is in a subtree there will be at least one '/' in the
  571. * returned string.
  572. */
  573. public String getPathString() {
  574. return toString(path);
  575. }
  576. /**
  577. * Get a copy of the entry's raw path bytes.
  578. *
  579. * @return raw path bytes.
  580. * @since 3.4
  581. */
  582. public byte[] getRawPath() {
  583. return path.clone();
  584. }
  585. /**
  586. * Use for debugging only !
  587. */
  588. @SuppressWarnings("nls")
  589. @Override
  590. public String toString() {
  591. return getFileMode() + " " + getLength() + " " + getLastModified()
  592. + " " + getObjectId() + " " + getStage() + " "
  593. + getPathString() + "\n";
  594. }
  595. /**
  596. * Copy the ObjectId and other meta fields from an existing entry.
  597. * <p>
  598. * This method copies everything except the path from one entry to another,
  599. * supporting renaming.
  600. *
  601. * @param src
  602. * the entry to copy ObjectId and meta fields from.
  603. */
  604. public void copyMetaData(final DirCacheEntry src) {
  605. copyMetaData(src, false);
  606. }
  607. /**
  608. * Copy the ObjectId and other meta fields from an existing entry.
  609. * <p>
  610. * This method copies everything except the path and possibly stage from one
  611. * entry to another, supporting renaming.
  612. *
  613. * @param src
  614. * the entry to copy ObjectId and meta fields from.
  615. * @param keepStage
  616. * if true, the stage attribute will not be copied
  617. */
  618. void copyMetaData(final DirCacheEntry src, boolean keepStage) {
  619. int origflags = NB.decodeUInt16(info, infoOffset + P_FLAGS);
  620. int newflags = NB.decodeUInt16(src.info, src.infoOffset + P_FLAGS);
  621. System.arraycopy(src.info, src.infoOffset, info, infoOffset, INFO_LEN);
  622. final int pLen = origflags & NAME_MASK;
  623. final int SHIFTED_STAGE_MASK = 0x3 << 12;
  624. final int pStageShifted;
  625. if (keepStage)
  626. pStageShifted = origflags & SHIFTED_STAGE_MASK;
  627. else
  628. pStageShifted = newflags & SHIFTED_STAGE_MASK;
  629. NB.encodeInt16(info, infoOffset + P_FLAGS, pStageShifted | pLen
  630. | (newflags & ~NAME_MASK & ~SHIFTED_STAGE_MASK));
  631. }
  632. /**
  633. * @return true if the entry contains extended flags.
  634. */
  635. boolean isExtended() {
  636. return (info[infoOffset + P_FLAGS] & EXTENDED) != 0;
  637. }
  638. private long decodeTS(final int pIdx) {
  639. final int base = infoOffset + pIdx;
  640. final int sec = NB.decodeInt32(info, base);
  641. final int ms = NB.decodeInt32(info, base + 4) / 1000000;
  642. return 1000L * sec + ms;
  643. }
  644. private void encodeTS(final int pIdx, final long when) {
  645. final int base = infoOffset + pIdx;
  646. NB.encodeInt32(info, base, (int) (when / 1000));
  647. NB.encodeInt32(info, base + 4, ((int) (when % 1000)) * 1000000);
  648. }
  649. private int getExtendedFlags() {
  650. if (isExtended())
  651. return NB.decodeUInt16(info, infoOffset + P_FLAGS2) << 16;
  652. else
  653. return 0;
  654. }
  655. private static void checkPath(byte[] path) {
  656. try {
  657. SystemReader.getInstance().checkPath(path);
  658. } catch (CorruptObjectException e) {
  659. InvalidPathException p = new InvalidPathException(toString(path));
  660. p.initCause(e);
  661. throw p;
  662. }
  663. }
  664. static String toString(final byte[] path) {
  665. return Constants.CHARSET.decode(ByteBuffer.wrap(path)).toString();
  666. }
  667. static int getMaximumInfoLength(boolean extended) {
  668. return extended ? INFO_LEN_EXTENDED : INFO_LEN;
  669. }
  670. }