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
45 import java.io.IOException;
46 import java.nio.file.Files;
47 import java.nio.file.Path;
48
49 import org.eclipse.jgit.lfs.lib.AnyLongObjectId;
50 import org.eclipse.jgit.lfs.lib.Constants;
51 import org.eclipse.jgit.lib.Repository;
52
53 /**
54 * Class which represents the lfs folder hierarchy inside a {@code .git} folder
55 *
56 * @since 4.6
57 */
58 public class Lfs {
59 private Path root;
60
61 private Path objDir;
62
63 private Path tmpDir;
64
65 /**
66 * Constructor for Lfs.
67 *
68 * @param root
69 * the path to the LFS media directory. Will be
70 * {@code "<repo>/.git/lfs"}
71 * @deprecated use {@link #Lfs(Repository)} instead.
72 */
73 @Deprecated
74 public Lfs(Path root) {
75 this.root = root;
76 }
77
78 /**
79 * Constructor for Lfs.
80 *
81 * @param db
82 * the associated repo
83 *
84 * @since 4.11
85 */
86 public Lfs(Repository db) {
87 this.root = db.getDirectory().toPath().resolve(Constants.LFS);
88 }
89
90 /**
91 * Get the LFS root directory
92 *
93 * @return the path to the LFS directory
94 */
95 public Path getLfsRoot() {
96 return root;
97 }
98
99 /**
100 * Get the path to the temporary directory used by LFS.
101 *
102 * @return the path to the temporary directory used by LFS. Will be
103 * {@code <repo>/.git/lfs/tmp}
104 */
105 public Path getLfsTmpDir() {
106 if (tmpDir == null) {
107 tmpDir = root.resolve("tmp"); //$NON-NLS-1$
108 }
109 return tmpDir;
110 }
111
112 /**
113 * Get the object directory used by LFS
114 *
115 * @return the path to the object directory used by LFS. Will be
116 * {@code <repo>/.git/lfs/objects}
117 */
118 public Path getLfsObjDir() {
119 if (objDir == null) {
120 objDir = root.resolve("objects"); //$NON-NLS-1$
121 }
122 return objDir;
123 }
124
125 /**
126 * Get the media file which stores the original content
127 *
128 * @param id
129 * the id of the mediafile
130 * @return the file which stores the original content. Its path will look
131 * like
132 * {@code "<repo>/.git/lfs/objects/<firstTwoLettersOfID>/<remainingLettersOfID>"}
133 */
134 public Path getMediaFile(AnyLongObjectId id) {
135 String idStr = id.name();
136 return getLfsObjDir().resolve(idStr.substring(0, 2))
137 .resolve(idStr.substring(2, 4)).resolve(idStr);
138 }
139
140 /**
141 * Create a new temp file in the LFS directory
142 *
143 * @return a new temporary file in the LFS directory
144 * @throws java.io.IOException
145 * when the temp file could not be created
146 */
147 public Path createTmpFile() throws IOException {
148 return Files.createTempFile(getLfsTmpDir(), null, null);
149 }
150
151 }