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.

Lfs.java 3.9KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134
  1. /*
  2. * Copyright (C) 2016, Christian Halstrick <christian.halstrick@sap.com>
  3. * and other copyright owners as documented in the project's IP log.
  4. *
  5. * This program and the accompanying materials are made available
  6. * under the terms of the Eclipse Distribution License v1.0 which
  7. * accompanies this distribution, is reproduced below, and is
  8. * available at http://www.eclipse.org/org/documents/edl-v10.php
  9. *
  10. * All rights reserved.
  11. *
  12. * Redistribution and use in source and binary forms, with or
  13. * without modification, are permitted provided that the following
  14. * conditions are met:
  15. *
  16. * - Redistributions of source code must retain the above copyright
  17. * notice, this list of conditions and the following disclaimer.
  18. *
  19. * - Redistributions in binary form must reproduce the above
  20. * copyright notice, this list of conditions and the following
  21. * disclaimer in the documentation and/or other materials provided
  22. * with the distribution.
  23. *
  24. * - Neither the name of the Eclipse Foundation, Inc. nor the
  25. * names of its contributors may be used to endorse or promote
  26. * products derived from this software without specific prior
  27. * written permission.
  28. *
  29. * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
  30. * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
  31. * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  32. * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  33. * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  34. * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  35. * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  36. * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  37. * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  38. * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  39. * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  40. * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  41. * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  42. */
  43. package org.eclipse.jgit.lfs;
  44. import java.io.IOException;
  45. import java.nio.file.Files;
  46. import java.nio.file.Path;
  47. import org.eclipse.jgit.lfs.lib.AnyLongObjectId;
  48. /**
  49. * Class which represents the lfs folder hierarchy inside a .git folder
  50. *
  51. * @since 4.6
  52. */
  53. public class Lfs {
  54. private Path root;
  55. private Path objDir;
  56. private Path tmpDir;
  57. /**
  58. * Constructor for Lfs.
  59. *
  60. * @param root
  61. * the path to the LFS media directory. Will be "<repo>/.git/lfs"
  62. */
  63. public Lfs(Path root) {
  64. this.root = root;
  65. }
  66. /**
  67. * Get the LFS root directory
  68. *
  69. * @return the path to the LFS directory
  70. */
  71. public Path getLfsRoot() {
  72. return root;
  73. }
  74. /**
  75. * Get the path to the temporary directory used by LFS.
  76. *
  77. * @return the path to the temporary directory used by LFS. Will be
  78. * {@code <repo>/.git/lfs/tmp}
  79. */
  80. public Path getLfsTmpDir() {
  81. if (tmpDir == null) {
  82. tmpDir = root.resolve("tmp"); //$NON-NLS-1$
  83. }
  84. return tmpDir;
  85. }
  86. /**
  87. * Get the object directory used by LFS
  88. *
  89. * @return the path to the object directory used by LFS. Will be
  90. * {@code <repo>/.git/lfs/objects}
  91. */
  92. public Path getLfsObjDir() {
  93. if (objDir == null) {
  94. objDir = root.resolve("objects"); //$NON-NLS-1$
  95. }
  96. return objDir;
  97. }
  98. /**
  99. * Get the media file which stores the original content
  100. *
  101. * @param id
  102. * the id of the mediafile
  103. * @return the file which stores the original content. This will be files
  104. * underneath
  105. * "<repo>/.git/lfs/objects/<firstTwoLettersOfID>/<remainingLettersOfID>"
  106. */
  107. public Path getMediaFile(AnyLongObjectId id) {
  108. String idStr = id.name();
  109. return getLfsObjDir().resolve(idStr.substring(0, 2))
  110. .resolve(idStr.substring(2));
  111. }
  112. /**
  113. * Create a new temp file in the LFS directory
  114. *
  115. * @return a new temporary file in the LFS directory
  116. * @throws java.io.IOException
  117. * when the temp file could not be created
  118. */
  119. public Path createTmpFile() throws IOException {
  120. return Files.createTempFile(getLfsTmpDir(), null, null);
  121. }
  122. }