-
Notifications
You must be signed in to change notification settings - Fork 3.9k
/
JarCreator.java
253 lines (231 loc) · 8.48 KB
/
JarCreator.java
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
// Copyright 2014 The Bazel Authors. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package com.google.devtools.build.buildjar.jarhelper;
import java.io.BufferedOutputStream;
import java.io.ByteArrayOutputStream;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.OutputStream;
import java.io.UncheckedIOException;
import java.nio.file.FileVisitResult;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.nio.file.SimpleFileVisitor;
import java.nio.file.attribute.BasicFileAttributes;
import java.util.Map;
import java.util.TreeMap;
import java.util.jar.Attributes;
import java.util.jar.JarOutputStream;
import java.util.jar.Manifest;
/**
* A class for creating Jar files. Allows normalization of Jar entries by setting their timestamp to
* the DOS epoch. All Jar entries are sorted alphabetically.
*/
public class JarCreator extends JarHelper {
// Map from Jar entry names to files. Use TreeMap so we can establish a canonical order for the
// entries regardless in what order they get added.
private final TreeMap<String, Path> jarEntries = new TreeMap<>();
private String manifestFile;
private String mainClass;
private String targetLabel;
private String injectingRuleKind;
/** @deprecated use {@link JarCreator(Path)} instead */
@Deprecated
public JarCreator(String fileName) {
this(Paths.get(fileName));
}
public JarCreator(Path path) {
super(path);
}
/**
* Adds an entry to the Jar file, normalizing the name.
*
* @param entryName the name of the entry in the Jar file
* @param path the path of the input for the entry
* @return true iff a new entry was added
*/
public boolean addEntry(String entryName, Path path) {
if (entryName.startsWith("/")) {
entryName = entryName.substring(1);
} else if (entryName.length() >= 3
&& Character.isLetter(entryName.charAt(0))
&& entryName.charAt(1) == ':'
&& (entryName.charAt(2) == '\\' || entryName.charAt(2) == '/')) {
// Windows absolute path, e.g. "D:\foo" or "e:/blah".
// Windows paths are case-insensitive, and support both backslashes and forward slashes.
entryName = entryName.substring(3);
} else if (entryName.startsWith("./")) {
entryName = entryName.substring(2);
}
return jarEntries.put(entryName, path) == null;
}
/**
* Adds an entry to the Jar file, normalizing the name.
*
* @param entryName the name of the entry in the Jar file
* @param fileName the name of the input file for the entry
* @return true iff a new entry was added
*/
public boolean addEntry(String entryName, String fileName) {
return addEntry(entryName, Paths.get(fileName));
}
/** @deprecated prefer {@link #addDirectory(Path)} */
@Deprecated
public void addDirectory(String directory) {
addDirectory(Paths.get(directory));
}
/**
* Adds the contents of a directory to the Jar file. All files below this directory will be added
* to the Jar file using the name relative to the directory as the name for the Jar entry.
*
* @param directory the directory to add to the jar
*/
public void addDirectory(Path directory) {
if (!Files.exists(directory)) {
throw new IllegalArgumentException("directory does not exist: " + directory);
}
try {
Files.walkFileTree(
directory,
new SimpleFileVisitor<Path>() {
@Override
public FileVisitResult preVisitDirectory(Path path, BasicFileAttributes attrs)
throws IOException {
if (!path.equals(directory)) {
// For consistency with legacy behaviour, include entries for directories except for
// the root.
addEntry(path, /* isDirectory= */ true);
}
return FileVisitResult.CONTINUE;
}
@Override
public FileVisitResult visitFile(Path path, BasicFileAttributes attrs)
throws IOException {
addEntry(path, /* isDirectory= */ false);
return FileVisitResult.CONTINUE;
}
void addEntry(Path path, boolean isDirectory) {
StringBuilder sb = new StringBuilder();
boolean first = true;
for (Path entry : directory.relativize(path)) {
if (!first) {
// use `/` as the directory separator for jar paths, even on Windows
sb.append('/');
}
sb.append(entry.getFileName());
first = false;
}
if (isDirectory) {
sb.append('/');
}
jarEntries.put(sb.toString(), path);
}
});
} catch (IOException e) {
throw new UncheckedIOException(e);
}
}
/**
* Sets the main.class entry for the manifest. A value of <code>null</code> (the default) will
* omit the entry.
*
* @param mainClass the fully qualified name of the main class
*/
public void setMainClass(String mainClass) {
this.mainClass = mainClass;
}
public void setJarOwner(String targetLabel, String injectingRuleKind) {
this.targetLabel = targetLabel;
this.injectingRuleKind = injectingRuleKind;
}
/**
* Sets filename for the manifest content. If this is set the manifest will be read from this file
* otherwise the manifest content will get generated on the fly.
*
* @param manifestFile the filename of the manifest file.
*/
public void setManifestFile(String manifestFile) {
this.manifestFile = manifestFile;
}
private byte[] manifestContent() throws IOException {
if (manifestFile != null) {
try (FileInputStream in = new FileInputStream(manifestFile)) {
return manifestContentImpl(new Manifest(in));
}
} else {
return manifestContentImpl(new Manifest());
}
}
private byte[] manifestContentImpl(Manifest manifest) throws IOException {
Attributes attributes = manifest.getMainAttributes();
attributes.put(Attributes.Name.MANIFEST_VERSION, "1.0");
Attributes.Name createdBy = new Attributes.Name("Created-By");
if (attributes.getValue(createdBy) == null) {
attributes.put(createdBy, "bazel");
}
if (mainClass != null) {
attributes.put(Attributes.Name.MAIN_CLASS, mainClass);
}
if (targetLabel != null) {
attributes.put(JarHelper.TARGET_LABEL, targetLabel);
}
if (injectingRuleKind != null) {
attributes.put(JarHelper.INJECTING_RULE_KIND, injectingRuleKind);
}
ByteArrayOutputStream out = new ByteArrayOutputStream();
manifest.write(out);
return out.toByteArray();
}
/**
* Executes the creation of the Jar file.
*
* @throws IOException if the Jar cannot be written or any of the entries cannot be read.
*/
public void execute() throws IOException {
try (OutputStream os = Files.newOutputStream(jarPath);
BufferedOutputStream bos = new BufferedOutputStream(os);
JarOutputStream out = new JarOutputStream(bos)) {
// Create the manifest entry in the Jar file
writeManifestEntry(out, manifestContent());
for (Map.Entry<String, Path> entry : jarEntries.entrySet()) {
copyEntry(out, entry.getKey(), entry.getValue());
}
}
}
/** A simple way to create Jar file using the JarCreator class. */
public static void main(String[] args) {
if (args.length < 1) {
System.err.println("usage: CreateJar output [root directories]");
System.exit(1);
}
String output = args[0];
JarCreator createJar = new JarCreator(output);
for (int i = 1; i < args.length; i++) {
createJar.addDirectory(args[i]);
}
createJar.setCompression(true);
createJar.setNormalize(true);
createJar.setVerbose(true);
long start = System.currentTimeMillis();
try {
createJar.execute();
} catch (IOException e) {
e.printStackTrace();
System.exit(1);
}
long stop = System.currentTimeMillis();
System.err.println((stop - start) + "ms.");
}
}