1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
|
/*
* Copyright (C) 2016, 2021 Christian Halstrick <christian.halstrick@sap.com> and others
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Distribution License v. 1.0 which is available at
* https://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
package org.eclipse.jgit.lfs;
import static java.nio.charset.StandardCharsets.UTF_8;
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.OutputStream;
import java.io.PrintStream;
import java.io.UnsupportedEncodingException;
import java.util.Locale;
import java.util.Objects;
import org.eclipse.jgit.annotations.Nullable;
import org.eclipse.jgit.lfs.lib.AnyLongObjectId;
import org.eclipse.jgit.lfs.lib.Constants;
import org.eclipse.jgit.lfs.lib.LongObjectId;
/**
* Represents an LFS pointer file
*
* @since 4.6
*/
public class LfsPointer implements Comparable<LfsPointer> {
/**
* The version of the LfsPointer file format
*/
public static final String VERSION = "https://git-lfs.github.com/spec/v1"; //$NON-NLS-1$
/**
* The version of the LfsPointer file format using legacy URL
* @since 4.7
*/
public static final String VERSION_LEGACY = "https://hawser.github.com/spec/v1"; //$NON-NLS-1$
/**
* Don't inspect files that are larger than this threshold to avoid
* excessive reading. No pointer file should be larger than this.
* @since 4.11
*/
public static final int SIZE_THRESHOLD = 200;
/**
* The name of the hash function as used in the pointer files. This will
* evaluate to "sha256"
*/
public static final String HASH_FUNCTION_NAME = Constants.LONG_HASH_FUNCTION
.toLowerCase(Locale.ROOT).replace("-", ""); //$NON-NLS-1$ //$NON-NLS-2$
private final AnyLongObjectId oid;
private final long size;
/**
* <p>Constructor for LfsPointer.</p>
*
* @param oid
* the id of the content
* @param size
* the size of the content
*/
public LfsPointer(AnyLongObjectId oid, long size) {
this.oid = oid;
this.size = size;
}
/**
* <p>Getter for the field <code>oid</code>.</p>
*
* @return the id of the content
*/
public AnyLongObjectId getOid() {
return oid;
}
/**
* <p>Getter for the field <code>size</code>.</p>
*
* @return the size of the content
*/
public long getSize() {
return size;
}
/**
* Encode this object into the LFS format defined by {@link #VERSION}
*
* @param out
* the {@link java.io.OutputStream} into which the encoded data should be
* written
*/
public void encode(OutputStream out) {
try (PrintStream ps = new PrintStream(out, false,
UTF_8.name())) {
ps.print("version "); //$NON-NLS-1$
ps.print(VERSION + "\n"); //$NON-NLS-1$
ps.print("oid " + HASH_FUNCTION_NAME + ":"); //$NON-NLS-1$ //$NON-NLS-2$
ps.print(oid.name() + "\n"); //$NON-NLS-1$
ps.print("size "); //$NON-NLS-1$
ps.print(size + "\n"); //$NON-NLS-1$
} catch (UnsupportedEncodingException e) {
// should not happen, we are using a standard charset
}
}
/**
* Try to parse the data provided by an InputStream to the format defined by
* {@link #VERSION}
*
* @param in
* the {@link java.io.InputStream} from where to read the data
* @return an {@link org.eclipse.jgit.lfs.LfsPointer} or <code>null</code>
* if the stream was not parseable as LfsPointer
* @throws java.io.IOException
*/
@Nullable
public static LfsPointer parseLfsPointer(InputStream in)
throws IOException {
boolean versionLine = false;
LongObjectId id = null;
long sz = -1;
// This parsing is a bit too general if we go by the spec at
// https://github.com/git-lfs/git-lfs/blob/master/docs/spec.md
// Comment lines are not mentioned in the spec, and the "version" line
// MUST be the first.
try (BufferedReader br = new BufferedReader(
new InputStreamReader(in, UTF_8))) {
for (String s = br.readLine(); s != null; s = br.readLine()) {
if (s.startsWith("#") || s.length() == 0) { //$NON-NLS-1$
continue;
} else if (s.startsWith("version")) { //$NON-NLS-1$
if (versionLine || s.length() < 8 || s.charAt(7) != ' ') {
return null; // Not a LFS pointer
}
String rest = s.substring(8).trim();
versionLine = VERSION.equals(rest)
|| VERSION_LEGACY.equals(rest);
if (!versionLine) {
return null; // Not a LFS pointer
}
} else {
try {
if (s.startsWith("oid sha256:")) { //$NON-NLS-1$
if (id != null) {
return null; // Not a LFS pointer
}
id = LongObjectId
.fromString(s.substring(11).trim());
} else if (s.startsWith("size")) { //$NON-NLS-1$
if (sz > 0 || s.length() < 5
|| s.charAt(4) != ' ') {
return null; // Not a LFS pointer
}
sz = Long.parseLong(s.substring(5).trim());
}
} catch (RuntimeException e) {
// We could not parse the line. If we have a version
// already, this is a corrupt LFS pointer. Otherwise it
// is just not an LFS pointer.
if (versionLine) {
throw e;
}
return null;
}
}
}
if (versionLine && id != null && sz > -1) {
return new LfsPointer(id, sz);
}
}
return null;
}
/** {@inheritDoc} */
@Override
public String toString() {
return "LfsPointer: oid=" + oid.name() + ", size=" //$NON-NLS-1$ //$NON-NLS-2$
+ size;
}
/**
* @since 4.11
*/
@Override
public int compareTo(LfsPointer o) {
int x = getOid().compareTo(o.getOid());
if (x != 0) {
return x;
}
return Long.compare(getSize(), o.getSize());
}
@Override
public int hashCode() {
return Objects.hash(getOid()) * 31 + Long.hashCode(getSize());
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj == null || getClass() != obj.getClass()) {
return false;
}
LfsPointer other = (LfsPointer) obj;
return Objects.equals(getOid(), other.getOid())
&& getSize() == other.getSize();
}
}
|
