forked from hazelcast/hazelcast
-
Notifications
You must be signed in to change notification settings - Fork 0
/
HazelcastManifestTransformer.java
411 lines (348 loc) · 16.5 KB
/
HazelcastManifestTransformer.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
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
/*
* Copyright (c) 2008-2021, Hazelcast, Inc. 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.hazelcast.buildutils;
import aQute.lib.osgi.Instruction;
import com.hazelcast.logging.ILogger;
import com.hazelcast.logging.Logger;
import org.apache.maven.plugins.shade.relocation.Relocator;
import org.apache.maven.plugins.shade.resource.ManifestResourceTransformer;
import java.io.IOException;
import java.io.InputStream;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.Objects;
import java.util.Set;
import java.util.jar.Attributes;
import java.util.jar.Attributes.Name;
import java.util.jar.JarEntry;
import java.util.jar.JarFile;
import java.util.jar.JarOutputStream;
import java.util.jar.Manifest;
import static java.util.Arrays.asList;
import static java.util.Collections.emptySet;
import static org.codehaus.plexus.util.IOUtil.close;
import static org.codehaus.plexus.util.StringUtils.join;
/**
* This transformer implementation is used to merge MANIFEST and OSGi
* bundle metadata in conjunction with the Maven Shade plugin when
* integrating multiple dependencies into one output JAR.
*/
public class HazelcastManifestTransformer extends ManifestResourceTransformer {
private static final ILogger LOGGER = Logger.getLogger(HazelcastManifestTransformer.class);
private static final String VERSION_PREFIX = "version=";
private static final String RESOLUTION_PREFIX = "resolution:=";
private static final String USES_PREFIX = "uses:=";
private static final int VERSION_OFFSET = 8;
private static final int USES_OFFSET = 7;
private static final String IMPORT_PACKAGE = "Import-Package";
private static final String EXPORT_PACKAGE = "Export-Package";
private static final Name AUTOMATIC_MODULE_NAME = new Name("Automatic-Module-Name");
// configuration
private String mainClass;
private Map<String, Object> manifestEntries;
private Map<String, String> overrideInstructions;
private final Map<String, PackageDefinition> importedPackages = new HashMap<>();
private final Map<String, PackageDefinition> exportedPackages = new HashMap<>();
private final List<InstructionDefinition> importOverrideInstructions = new ArrayList<>();
private final List<InstructionDefinition> exportOverrideInstructions = new ArrayList<>();
private Manifest shadedManifest;
@Override
public void setMainClass(String mainClass) {
this.mainClass = mainClass;
super.setMainClass(mainClass);
}
@Override
public void setManifestEntries(Map<String, Object> manifestEntries) {
this.manifestEntries = manifestEntries;
super.setManifestEntries(manifestEntries);
}
public void setOverrideInstructions(Map<String, String> overrideInstructions) {
this.overrideInstructions = overrideInstructions;
}
@Override
public boolean canTransformResource(String resource) {
return JarFile.MANIFEST_NAME.equals(resource.toUpperCase(Locale.ROOT));
}
@Override
public void processResource(String resource, InputStream inputStream, List<Relocator> relocators, long time)
throws IOException {
Attributes attributes;
if (shadedManifest == null) {
shadedManifest = new Manifest(inputStream);
attributes = shadedManifest.getMainAttributes();
} else {
Manifest manifest = new Manifest(inputStream);
attributes = manifest.getMainAttributes();
}
String importPackages = attributes.getValue(IMPORT_PACKAGE);
if (importPackages != null) {
List<String> definitions = ElementParser.parseDelimitedString(importPackages, ',', true);
for (String definition : definitions) {
PackageDefinition packageDefinition = new PackageDefinition(definition);
String packageName = packageDefinition.packageName;
PackageDefinition oldPackageDefinition = importedPackages.get(packageName);
importedPackages.put(packageName, findStrongerDefinition(packageDefinition, oldPackageDefinition));
}
}
String exportPackages = attributes.getValue(EXPORT_PACKAGE);
if (exportPackages != null) {
List<String> definitions = ElementParser.parseDelimitedString(exportPackages, ',', true);
for (String definition : definitions) {
PackageDefinition packageDefinition = new PackageDefinition(definition);
String packageName = packageDefinition.packageName;
PackageDefinition oldPackageDefinition = exportedPackages.get(packageName);
exportedPackages.put(packageName, mergeExportUsesConstraint(packageDefinition, oldPackageDefinition));
}
}
close(inputStream);
}
private PackageDefinition findStrongerDefinition(PackageDefinition packageDefinition,
PackageDefinition oldPackageDefinition) {
// if the override is a remove instruction skip all other tests
if (packageDefinition.removeImport) {
return packageDefinition;
}
// if no old definition or new definition is required import we take the new one
if (oldPackageDefinition == null
|| oldPackageDefinition.resolutionOptional && !packageDefinition.resolutionOptional) {
return packageDefinition;
}
// if old definition was required import but new isn't we take the old one
if (!oldPackageDefinition.resolutionOptional && packageDefinition.resolutionOptional) {
return oldPackageDefinition;
}
if (oldPackageDefinition.version == null && packageDefinition.version != null) {
return packageDefinition;
}
if (oldPackageDefinition.version != null && packageDefinition.version == null) {
return oldPackageDefinition;
}
return oldPackageDefinition;
}
private PackageDefinition mergeExportUsesConstraint(PackageDefinition packageDefinition,
PackageDefinition oldPackageDefinition) {
Set<String> uses = new LinkedHashSet<>();
if (oldPackageDefinition != null) {
uses.addAll(oldPackageDefinition.uses);
}
uses.addAll(packageDefinition.uses);
String packageName = packageDefinition.packageName;
boolean resolutionOptional = packageDefinition.resolutionOptional;
String version = packageDefinition.version;
return new PackageDefinition(packageName, resolutionOptional, version, uses);
}
@Override
public boolean hasTransformedResource() {
return true;
}
@Override
public void modifyOutputStream(JarOutputStream jarOutputStream) throws IOException {
if (shadedManifest == null) {
shadedManifest = new Manifest();
}
Attributes attributes = shadedManifest.getMainAttributes();
if (overrideInstructions != null) {
precompileOverrideInstructions();
attributes.putValue(IMPORT_PACKAGE, join(shadeImports().iterator(), ","));
attributes.putValue(EXPORT_PACKAGE, join(shadeExports().iterator(), ","));
}
attributes.putValue("Created-By", "HazelcastManifestTransformer through Shade Plugin");
if (mainClass != null) {
attributes.put(Attributes.Name.MAIN_CLASS, mainClass);
}
if (manifestEntries != null) {
for (Map.Entry<String, Object> entry : manifestEntries.entrySet()) {
attributes.put(new Attributes.Name(entry.getKey()), entry.getValue());
}
}
// the Manifest in hazelcast uberjar won't have the Automatic-Module-Name
attributes.remove(AUTOMATIC_MODULE_NAME);
jarOutputStream.putNextEntry(new JarEntry(JarFile.MANIFEST_NAME));
shadedManifest.write(jarOutputStream);
jarOutputStream.flush();
}
private void precompileOverrideInstructions() {
String importPackageInstructions = overrideInstructions.get(IMPORT_PACKAGE);
if (importPackageInstructions != null) {
List<String> packageInstructions = ElementParser.parseDelimitedString(importPackageInstructions, ',', true);
for (String packageInstruction : packageInstructions) {
PackageDefinition packageDefinition = new PackageDefinition(packageInstruction);
Instruction instruction = Instruction.getPattern(packageDefinition.packageName);
LOGGER.fine("Compiled import instruction '" + packageInstruction + "' -> " + instruction);
importOverrideInstructions.add(new InstructionDefinition(packageDefinition, instruction));
}
}
String exportPackageInstructions = overrideInstructions.get(EXPORT_PACKAGE);
if (exportPackageInstructions != null) {
List<String> packageInstructions = ElementParser.parseDelimitedString(exportPackageInstructions, ',', true);
for (String packageInstruction : packageInstructions) {
PackageDefinition packageDefinition = new PackageDefinition(packageInstruction);
Instruction instruction = Instruction.getPattern(packageDefinition.packageName);
LOGGER.fine("Compiled export instruction '" + packageInstruction + "' -> " + instruction);
exportOverrideInstructions.add(new InstructionDefinition(packageDefinition, instruction));
}
}
}
private Set<String> shadeExports() {
Set<String> exports = new LinkedHashSet<>();
for (Map.Entry<String, PackageDefinition> entry : exportedPackages.entrySet()) {
String definition = entry.getValue().buildDefinition(false);
exports.add(definition);
LOGGER.fine("Adding shaded export -> " + definition);
}
return exports;
}
private Set<String> shadeImports() {
for (String export : exportedPackages.keySet()) {
PackageDefinition definition = new PackageDefinition(export);
importedPackages.remove(definition.packageName);
}
Set<String> imports = new LinkedHashSet<>();
for (Map.Entry<String, PackageDefinition> entry : importedPackages.entrySet()) {
PackageDefinition original = entry.getValue();
PackageDefinition overridden = overridePackageDefinitionResolution(original);
if (overridden != null) {
String definition = overridden.buildDefinition(true);
imports.add(definition);
LOGGER.fine("Adding shaded import -> " + definition);
} else {
LOGGER.fine("Removing shaded import -> " + entry.getValue().packageName);
}
}
return imports;
}
private PackageDefinition overridePackageDefinitionResolution(PackageDefinition packageDefinition) {
for (InstructionDefinition instructionDefinition : importOverrideInstructions) {
Instruction instruction = instructionDefinition.instruction;
if (instruction.matches(packageDefinition.packageName)) {
// is remove instruction?
if (instruction.isNegated()) {
LOGGER.fine("Instruction '" + instruction + "' -> package '" + packageDefinition.packageName + "'");
return null;
}
LOGGER.fine("Instruction '" + instruction + "' -> package '" + packageDefinition.packageName + "'");
PackageDefinition override = instructionDefinition.packageDefinition;
String packageName = packageDefinition.packageName;
String version = packageDefinition.version;
Set<String> uses = packageDefinition.uses;
return new PackageDefinition(packageName, override.resolutionOptional, version, uses);
}
}
return packageDefinition;
}
static final class PackageDefinition {
private final boolean removeImport;
private final String packageName;
private final boolean resolutionOptional;
private final String version;
private final Set<String> uses;
PackageDefinition(String definition) {
String[] tokens = definition.split(";");
this.removeImport = tokens[0].startsWith("!");
this.packageName = tokens[0];
this.resolutionOptional = findResolutionConstraint(tokens);
this.version = findVersionConstraint(tokens);
this.uses = findUsesConstraint(tokens);
}
PackageDefinition(String packageName, boolean resolutionOptional, String version, Set<String> uses) {
this.removeImport = packageName.startsWith("!");
this.packageName = packageName;
this.resolutionOptional = resolutionOptional;
this.version = version;
this.uses = new LinkedHashSet<>(uses);
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
PackageDefinition that = (PackageDefinition) o;
return Objects.equals(packageName, that.packageName);
}
@Override
public int hashCode() {
return packageName != null ? packageName.hashCode() : 0;
}
@Override
public String toString() {
return "PackageDefinition{"
+ "packageName='" + packageName + '\''
+ ", resolutionOptional=" + resolutionOptional
+ ", version='" + version + '\''
+ ", uses=" + uses + '}';
}
String buildDefinition(boolean addResolutionConstraint) {
StringBuilder sb = new StringBuilder(packageName);
if (addResolutionConstraint && resolutionOptional) {
sb.append(";").append(RESOLUTION_PREFIX).append("optional");
}
if (version != null) {
sb.append(";").append(VERSION_PREFIX).append(version);
}
if (uses != null && !uses.isEmpty()) {
sb.append(";").append(USES_PREFIX).append('"').append(join(uses.iterator(), ",")).append('"');
}
return sb.toString();
}
private String findVersionConstraint(String[] tokens) {
for (String token : tokens) {
if (token.startsWith(VERSION_PREFIX)) {
return token.substring(VERSION_OFFSET);
}
}
return null;
}
private boolean findResolutionConstraint(String[] tokens) {
for (String token : tokens) {
if (token.startsWith(RESOLUTION_PREFIX)) {
return token.toLowerCase(Locale.ROOT).equals("resolution:=optional");
}
}
return false;
}
private Set<String> findUsesConstraint(String[] tokens) {
for (String token : tokens) {
if (token.startsWith(USES_PREFIX)) {
String packages = token.substring(USES_OFFSET, token.length() - 1);
String[] sepPackages = packages.split(",");
return new LinkedHashSet<>(asList(sepPackages));
}
}
return emptySet();
}
}
static final class InstructionDefinition {
private final PackageDefinition packageDefinition;
private final Instruction instruction;
InstructionDefinition(PackageDefinition packageDefinition, Instruction instruction) {
this.packageDefinition = packageDefinition;
this.instruction = instruction;
}
@Override
public String toString() {
return "InstructionDefinition{"
+ "packageDefinition=" + packageDefinition
+ ", instruction=" + instruction + '}';
}
}
}