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

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