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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
|
/*
* Copyright (C) 2007, Robin Rosenberg <robin.rosenberg@dewire.com>
* Copyright (C) 2006-2008, Shawn O. Pearce <spearce@spearce.org> 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.lib;
import java.io.IOException;
import java.io.OutputStream;
/**
* Constants describing various file modes recognized by GIT.
* <p>
* GIT uses a subset of the available UNIX file permission bits. The
* <code>FileMode</code> class provides access to constants defining the modes
* actually used by GIT.
* </p>
*/
public abstract class FileMode {
/**
* Mask to apply to a file mode to obtain its type bits.
*
* @see #TYPE_TREE
* @see #TYPE_SYMLINK
* @see #TYPE_FILE
* @see #TYPE_GITLINK
* @see #TYPE_MISSING
*/
public static final int TYPE_MASK = 0170000;
/** Bit pattern for {@link #TYPE_MASK} matching {@link #TREE}. */
public static final int TYPE_TREE = 0040000;
/** Bit pattern for {@link #TYPE_MASK} matching {@link #SYMLINK}. */
public static final int TYPE_SYMLINK = 0120000;
/** Bit pattern for {@link #TYPE_MASK} matching {@link #REGULAR_FILE}. */
public static final int TYPE_FILE = 0100000;
/** Bit pattern for {@link #TYPE_MASK} matching {@link #GITLINK}. */
public static final int TYPE_GITLINK = 0160000;
/** Bit pattern for {@link #TYPE_MASK} matching {@link #MISSING}. */
public static final int TYPE_MISSING = 0000000;
/**
* Mode indicating an entry is a tree (aka directory).
*/
public static final FileMode TREE = new FileMode(TYPE_TREE,
Constants.OBJ_TREE) {
@Override
@SuppressWarnings("NonOverridingEquals")
public boolean equals(int modeBits) {
return (modeBits & TYPE_MASK) == TYPE_TREE;
}
};
/** Mode indicating an entry is a symbolic link. */
public static final FileMode SYMLINK = new FileMode(TYPE_SYMLINK,
Constants.OBJ_BLOB) {
@Override
@SuppressWarnings("NonOverridingEquals")
public boolean equals(int modeBits) {
return (modeBits & TYPE_MASK) == TYPE_SYMLINK;
}
};
/** Mode indicating an entry is a non-executable file. */
public static final FileMode REGULAR_FILE = new FileMode(0100644,
Constants.OBJ_BLOB) {
@Override
@SuppressWarnings("NonOverridingEquals")
public boolean equals(int modeBits) {
return (modeBits & TYPE_MASK) == TYPE_FILE && (modeBits & 0111) == 0;
}
};
/** Mode indicating an entry is an executable file. */
public static final FileMode EXECUTABLE_FILE = new FileMode(0100755,
Constants.OBJ_BLOB) {
@Override
@SuppressWarnings("NonOverridingEquals")
public boolean equals(int modeBits) {
return (modeBits & TYPE_MASK) == TYPE_FILE && (modeBits & 0111) != 0;
}
};
/** Mode indicating an entry is a submodule commit in another repository. */
public static final FileMode GITLINK = new FileMode(TYPE_GITLINK,
Constants.OBJ_COMMIT) {
@Override
@SuppressWarnings("NonOverridingEquals")
public boolean equals(int modeBits) {
return (modeBits & TYPE_MASK) == TYPE_GITLINK;
}
};
/** Mode indicating an entry is missing during parallel walks. */
public static final FileMode MISSING = new FileMode(TYPE_MISSING,
Constants.OBJ_BAD) {
@Override
@SuppressWarnings("NonOverridingEquals")
public boolean equals(int modeBits) {
return modeBits == 0;
}
};
/**
* Convert a set of mode bits into a FileMode enumerated value.
*
* @param bits
* the mode bits the caller has somehow obtained.
* @return the FileMode instance that represents the given bits.
*/
public static final FileMode fromBits(int bits) {
switch (bits & TYPE_MASK) {
case TYPE_MISSING:
if (bits == 0)
return MISSING;
break;
case TYPE_TREE:
return TREE;
case TYPE_FILE:
if ((bits & 0111) != 0)
return EXECUTABLE_FILE;
return REGULAR_FILE;
case TYPE_SYMLINK:
return SYMLINK;
case TYPE_GITLINK:
return GITLINK;
}
return new FileMode(bits, Constants.OBJ_BAD) {
@Override
@SuppressWarnings("NonOverridingEquals")
public boolean equals(int a) {
return bits == a;
}
};
}
private final byte[] octalBytes;
private final int modeBits;
private final int objectType;
private FileMode(int mode, int expType) {
modeBits = mode;
objectType = expType;
if (mode != 0) {
final byte[] tmp = new byte[10];
int p = tmp.length;
while (mode != 0) {
tmp[--p] = (byte) ('0' + (mode & 07));
mode >>= 3;
}
octalBytes = new byte[tmp.length - p];
for (int k = 0; k < octalBytes.length; k++) {
octalBytes[k] = tmp[p + k];
}
} else {
octalBytes = new byte[] { '0' };
}
}
/**
* Test a file mode for equality with this
* {@link org.eclipse.jgit.lib.FileMode} object.
*
* @param modebits
* a int.
* @return true if the mode bits represent the same mode as this object
*/
@SuppressWarnings("NonOverridingEquals")
public abstract boolean equals(int modebits);
/**
* Copy this mode as a sequence of octal US-ASCII bytes.
* <p>
* The mode is copied as a sequence of octal digits using the US-ASCII
* character encoding. The sequence does not use a leading '0' prefix to
* indicate octal notation. This method is suitable for generation of a mode
* string within a GIT tree object.
* </p>
*
* @param os
* stream to copy the mode to.
* @throws java.io.IOException
* the stream encountered an error during the copy.
*/
public void copyTo(OutputStream os) throws IOException {
os.write(octalBytes);
}
/**
* Copy this mode as a sequence of octal US-ASCII bytes.
*
* The mode is copied as a sequence of octal digits using the US-ASCII
* character encoding. The sequence does not use a leading '0' prefix to
* indicate octal notation. This method is suitable for generation of a mode
* string within a GIT tree object.
*
* @param buf
* buffer to copy the mode to.
* @param ptr
* position within {@code buf} for first digit.
*/
public void copyTo(byte[] buf, int ptr) {
System.arraycopy(octalBytes, 0, buf, ptr, octalBytes.length);
}
/**
* Copy the number of bytes written by {@link #copyTo(OutputStream)}.
*
* @return the number of bytes written by {@link #copyTo(OutputStream)}.
*/
public int copyToLength() {
return octalBytes.length;
}
/**
* Get the object type that should appear for this type of mode.
* <p>
* See the object type constants in {@link org.eclipse.jgit.lib.Constants}.
*
* @return one of the well known object type constants.
*/
public int getObjectType() {
return objectType;
}
/**
* {@inheritDoc}
* <p>
* Format this mode as an octal string (for debugging only).
*/
@Override
public String toString() {
return Integer.toOctalString(modeBits);
}
/**
* Get the mode bits as an integer.
*
* @return The mode bits as an integer.
*/
public int getBits() {
return modeBits;
}
}
|
