View Javadoc
1   /*
2    * Copyright (C) 2015, Matthias Sohn <matthias.sohn@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.server.fs;
44  
45  import static org.eclipse.jgit.util.HttpSupport.HDR_AUTHORIZATION;
46  
47  import java.io.IOException;
48  import java.nio.channels.FileChannel;
49  import java.nio.channels.ReadableByteChannel;
50  import java.nio.file.Files;
51  import java.nio.file.Path;
52  import java.nio.file.StandardOpenOption;
53  import java.util.Collections;
54  
55  import org.eclipse.jgit.annotations.Nullable;
56  import org.eclipse.jgit.lfs.internal.AtomicObjectOutputStream;
57  import org.eclipse.jgit.lfs.lib.AnyLongObjectId;
58  import org.eclipse.jgit.lfs.lib.Constants;
59  import org.eclipse.jgit.lfs.server.LargeFileRepository;
60  import org.eclipse.jgit.lfs.server.Response;
61  import org.eclipse.jgit.lfs.server.Response.Action;
62  
63  /**
64   * Repository storing large objects in the file system
65   *
66   * @since 4.3
67   */
68  public class FileLfsRepository implements LargeFileRepository {
69  
70  	private final String url;
71  	private final Path dir;
72  
73  	/**
74  	 * @param url
75  	 *            external URL of this repository
76  	 * @param dir
77  	 *            storage directory
78  	 * @throws IOException
79  	 */
80  	public FileLfsRepository(String url, Path dir) throws IOException {
81  		this.url = url;
82  		this.dir = dir;
83  		Files.createDirectories(dir);
84  	}
85  
86  	@Override
87  	public Response.Action getDownloadAction(AnyLongObjectId id) {
88  		return getAction(id);
89  	}
90  
91  	@Override
92  	public Action getUploadAction(AnyLongObjectId id, long size) {
93  		return getAction(id);
94  	}
95  
96  	@Override
97  	public @Nullable Action getVerifyAction(AnyLongObjectId id) {
98  		return null;
99  	}
100 
101 	@Override
102 	public long getSize(AnyLongObjectId id) throws IOException {
103 		Path p = getPath(id);
104 		if (Files.exists(p)) {
105 			return Files.size(p);
106 		} else {
107 			return -1;
108 		}
109 	}
110 
111 	/**
112 	 * Get the storage directory
113 	 *
114 	 * @return the path of the storage directory
115 	 */
116 	public Path getDir() {
117 		return dir;
118 	}
119 
120 	/**
121 	 * Get the path where the given object is stored
122 	 *
123 	 * @param id
124 	 *            id of a large object
125 	 * @return path the object's storage path
126 	 */
127 	protected Path getPath(AnyLongObjectId id) {
128 		StringBuilder s = new StringBuilder(
129 				Constants.LONG_OBJECT_ID_STRING_LENGTH + 6);
130 		s.append(toHexCharArray(id.getFirstByte())).append('/');
131 		s.append(toHexCharArray(id.getSecondByte())).append('/');
132 		s.append(id.name());
133 		return dir.resolve(s.toString());
134 	}
135 
136 	private Response.Action getAction(AnyLongObjectId id) {
137 		Response.Action a = new Response.Action();
138 		a.href = url + id.getName();
139 		a.header = Collections.singletonMap(HDR_AUTHORIZATION, "not:required"); //$NON-NLS-1$
140 		return a;
141 	}
142 
143 	ReadableByteChannel getReadChannel(AnyLongObjectId id)
144 			throws IOException {
145 		return FileChannel.open(getPath(id), StandardOpenOption.READ);
146 	}
147 
148 	AtomicObjectOutputStream getOutputStream(AnyLongObjectId id)
149 			throws IOException {
150 		Path path = getPath(id);
151 		Path parent = path.getParent();
152 		if (parent != null) {
153 			Files.createDirectories(parent);
154 		}
155 		return new AtomicObjectOutputStream(path, id);
156 	}
157 
158 	private static char[] toHexCharArray(int b) {
159 		final char[] dst = new char[2];
160 		formatHexChar(dst, 0, b);
161 		return dst;
162 	}
163 
164 	private static final char[] hexchar = { '0', '1', '2', '3', '4', '5', '6',
165 			'7', '8', '9', 'a', 'b', 'c', 'd', 'e', 'f' };
166 
167 	private static void formatHexChar(final char[] dst, final int p, int b) {
168 		int o = p + 1;
169 		while (o >= p && b != 0) {
170 			dst[o--] = hexchar[b & 0xf];
171 			b >>>= 4;
172 		}
173 		while (o >= p)
174 			dst[o--] = '0';
175 	}
176 }