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
51 /**
52 * Class which represents the lfs folder hierarchy inside a .git folder
53 *
54 * @since 4.6
55 */
56 public class Lfs {
57 private Path root;
58
59 private Path objDir;
60
61 private Path tmpDir;
62
63 /**
64 * @param root
65 * the path to the LFS media directory. Will be "<repo>/.git/lfs"
66 */
67 public Lfs(Path root) {
68 this.root = root;
69 }
70
71 /**
72 * @return the path to the LFS directory
73 */
74 public Path getLfsRoot() {
75 return root;
76 }
77
78 /**
79 * @return the path to the temp directory used by LFS. Will be
80 * "<repo>/.git/lfs/tmp"
81 */
82 public Path getLfsTmpDir() {
83 if (tmpDir == null) {
84 tmpDir = root.resolve("tmp"); //$NON-NLS-1$
85 }
86 return tmpDir;
87 }
88
89 /**
90 * @return the path to the object directory used by LFS. Will be
91 * "<repo>/.git/lfs/objects"
92 */
93 public Path getLfsObjDir() {
94 if (objDir == null) {
95 objDir = root.resolve("objects"); //$NON-NLS-1$
96 }
97 return objDir;
98 }
99
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 /**
114 * Create a new temp file in the LFS directory
115 *
116 * @return a new temporary file in the LFS directory
117 * @throws IOException
118 * when the temp file could not be created
119 */
120 public Path createTmpFile() throws IOException {
121 return Files.createTempFile(getLfsTmpDir(), null, null);
122 }
123
124 }