View Javadoc
1   /*
2    * Copyright (C) 2017, Markus Duft <markus.duft@ssi-schaefer.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  import java.nio.file.attribute.BasicFileAttributes;
49  
50  import org.eclipse.jgit.errors.LargeObjectException;
51  import org.eclipse.jgit.errors.MissingObjectException;
52  import org.eclipse.jgit.lib.Constants;
53  import org.eclipse.jgit.lib.ObjectLoader;
54  import org.eclipse.jgit.lib.ObjectStream;
55  import org.eclipse.jgit.storage.pack.PackConfig;
56  import org.eclipse.jgit.util.IO;
57  
58  /**
59   * An {@link ObjectLoader} implementation that reads a media file from the LFS
60   * storage.
61   *
62   * @since 4.11
63   */
64  public class LfsBlobLoader extends ObjectLoader {
65  
66  	private Path mediaFile;
67  
68  	private BasicFileAttributes attributes;
69  
70  	private byte[] cached;
71  
72  	/**
73  	 * Create a loader for the LFS media file at the given path.
74  	 *
75  	 * @param mediaFile
76  	 *            path to the file
77  	 * @throws IOException
78  	 *             in case of an error reading attributes
79  	 */
80  	public LfsBlobLoader(Path mediaFile) throws IOException {
81  		this.mediaFile = mediaFile;
82  		this.attributes = Files.readAttributes(mediaFile,
83  				BasicFileAttributes.class);
84  	}
85  
86  	@Override
87  	public int getType() {
88  		return Constants.OBJ_BLOB;
89  	}
90  
91  	@Override
92  	public long getSize() {
93  		return attributes.size();
94  	}
95  
96  	@Override
97  	public byte[] getCachedBytes() throws LargeObjectException {
98  		if (getSize() > PackConfig.DEFAULT_BIG_FILE_THRESHOLD) {
99  			throw new LargeObjectException();
100 		}
101 
102 		if (cached == null) {
103 			try {
104 				cached = IO.readFully(mediaFile.toFile());
105 			} catch (IOException ioe) {
106 				throw new LargeObjectException(ioe);
107 			}
108 		}
109 		return cached;
110 	}
111 
112 	@Override
113 	public ObjectStream openStream()
114 			throws MissingObjectException, IOException {
115 		return new ObjectStream.Filter(getType(), getSize(),
116 				Files.newInputStream(mediaFile));
117 	}
118 
119 }