forked from apache/maven-shade-plugin
-
Notifications
You must be signed in to change notification settings - Fork 0
/
MinijarFilter.java
346 lines (310 loc) · 12 KB
/
MinijarFilter.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
package org.apache.maven.plugins.shade.filter;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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.
*/
import org.apache.maven.artifact.Artifact;
import org.apache.maven.artifact.DependencyResolutionRequiredException;
import org.apache.maven.plugin.logging.Log;
import org.apache.maven.project.MavenProject;
import org.vafer.jdependency.Clazz;
import org.vafer.jdependency.Clazzpath;
import org.vafer.jdependency.ClazzpathUnit;
import static java.nio.charset.StandardCharsets.UTF_8;
import java.io.BufferedReader;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.util.Collections;
import java.util.Enumeration;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import java.util.jar.JarEntry;
import java.util.jar.JarFile;
import java.util.zip.ZipException;
/**
* A filter that prevents the inclusion of classes not required in the final jar.
*/
public class MinijarFilter
implements Filter
{
private Log log;
private Set<Clazz> removable;
private int classesKept;
private int classesRemoved;
//[MSHADE-209] This is introduced only for testing purposes which shows
// there is something wrong with the design of this class. (SoC?)
// unfortunately i don't have a better idea at the moment.
MinijarFilter( int classesKept, int classesRemoved, Log log )
{
this.classesKept = classesKept;
this.classesRemoved = classesRemoved;
this.log = log;
}
/**
* @param project {@link MavenProject}
* @param log {@link Log}
* @throws IOException in case of error.
*/
public MinijarFilter( MavenProject project, Log log )
throws IOException
{
this( project, log, Collections.<SimpleFilter>emptyList() );
}
/**
* @param project {@link MavenProject}
* @param log {@link Log}
* @param simpleFilters {@link SimpleFilter}
* @throws IOException in case of errors.
* @since 1.6
*/
public MinijarFilter( MavenProject project, Log log, List<SimpleFilter> simpleFilters )
throws IOException
{
this.log = log;
File artifactFile = project.getArtifact().getFile();
if ( artifactFile != null )
{
Clazzpath cp = new Clazzpath();
ClazzpathUnit artifactUnit = cp.addClazzpathUnit( new FileInputStream( artifactFile ), project.toString() );
for ( Artifact dependency : project.getArtifacts() )
{
addDependencyToClasspath( cp, dependency );
}
removable = cp.getClazzes();
if ( removable.remove( new Clazz( "module-info" ) ) )
{
log.warn( "Removing module-info from " + artifactFile.getName() );
}
removePackages( artifactUnit );
removable.removeAll( artifactUnit.getClazzes() );
removable.removeAll( artifactUnit.getTransitiveDependencies() );
removeSpecificallyIncludedClasses( project,
simpleFilters == null ? Collections.<SimpleFilter>emptyList() : simpleFilters );
removeServices( project, cp );
}
}
private void removeServices( final MavenProject project, final Clazzpath cp )
{
boolean repeatScan;
do
{
repeatScan = false;
final Set<Clazz> neededClasses = cp.getClazzes();
neededClasses.removeAll( removable );
try
{
// getRuntimeClasspathElements returns a list of
// - the build output directory
// - all the paths to the dependencies' jars
// We thereby need to ignore the build directory because we don't want
// to remove anything from it, as it's the starting point of the
// minification process.
for ( final String fileName : project.getRuntimeClasspathElements() )
{
// Ignore the build directory from this project
if ( fileName.equals( project.getBuild().getOutputDirectory() ) )
{
continue;
}
if ( removeServicesFromJar( cp, neededClasses, fileName ) )
{
repeatScan = true;
}
}
}
catch ( final DependencyResolutionRequiredException e )
{
log.warn( e.getMessage() );
}
}
while ( repeatScan );
}
private boolean removeServicesFromJar( Clazzpath cp, Set<Clazz> neededClasses, String fileName )
{
boolean repeatScan = false;
try ( final JarFile jar = new JarFile( fileName ) )
{
for ( final Enumeration<JarEntry> entries = jar.entries(); entries.hasMoreElements(); )
{
final JarEntry jarEntry = entries.nextElement();
if ( jarEntry.isDirectory() || !jarEntry.getName().startsWith( "META-INF/services/" ) )
{
continue;
}
final String serviceClassName = jarEntry.getName().substring( "META-INF/services/".length() );
final boolean isNeededClass = neededClasses.contains( cp.getClazz( serviceClassName ) );
if ( !isNeededClass )
{
continue;
}
try ( final BufferedReader configFileReader = new BufferedReader(
new InputStreamReader( jar.getInputStream( jarEntry ), UTF_8 ) ) )
{
// check whether the found classes use services in turn
repeatScan = scanServiceProviderConfigFile( cp, configFileReader );
}
catch ( final IOException e )
{
log.warn( e.getMessage() );
}
}
}
catch ( final IOException e )
{
log.warn( "Not a JAR file candidate. Ignoring classpath element '" + fileName + "' (" + e + ")." );
}
return repeatScan;
}
private boolean scanServiceProviderConfigFile( Clazzpath cp, BufferedReader configFileReader ) throws IOException
{
boolean serviceClassFound = false;
for ( String line = configFileReader.readLine(); line != null; line = configFileReader.readLine() )
{
final String className = line.split( "#", 2 )[0].trim();
if ( className.isEmpty() )
{
continue;
}
final Clazz clazz = cp.getClazz( className );
if ( clazz == null || !removable.contains( clazz ) )
{
continue;
}
log.debug( className + " was not removed because it is a service" );
removeClass( clazz );
serviceClassFound = true;
}
return serviceClassFound;
}
private void removeClass( final Clazz clazz )
{
removable.remove( clazz );
removable.removeAll( clazz.getTransitiveDependencies() );
}
private ClazzpathUnit addDependencyToClasspath( Clazzpath cp, Artifact dependency )
throws IOException
{
ClazzpathUnit clazzpathUnit = null;
try ( InputStream is = new FileInputStream( dependency.getFile() ) )
{
clazzpathUnit = cp.addClazzpathUnit( is, dependency.toString() );
}
catch ( ZipException e )
{
log.warn( dependency.getFile()
+ " could not be unpacked/read for minimization; dependency is probably malformed." );
IOException ioe = new IOException( "Dependency " + dependency.toString() + " in file "
+ dependency.getFile() + " could not be unpacked. File is probably corrupt", e );
throw ioe;
}
catch ( ArrayIndexOutOfBoundsException | IllegalArgumentException e )
{
// trap ArrayIndexOutOfBoundsExceptions caused by malformed dependency classes (MSHADE-107)
log.warn( dependency.toString()
+ " could not be analyzed for minimization; dependency is probably malformed." );
}
return clazzpathUnit;
}
private void removePackages( ClazzpathUnit artifactUnit )
{
Set<String> packageNames = new HashSet<>();
removePackages( artifactUnit.getClazzes(), packageNames );
removePackages( artifactUnit.getTransitiveDependencies(), packageNames );
}
private void removePackages( Set<Clazz> clazzes, Set<String> packageNames )
{
for ( Clazz clazz : clazzes )
{
String name = clazz.getName();
while ( name.contains( "." ) )
{
name = name.substring( 0, name.lastIndexOf( '.' ) );
if ( packageNames.add( name ) )
{
removable.remove( new Clazz( name + ".package-info" ) );
}
}
}
}
private void removeSpecificallyIncludedClasses( MavenProject project, List<SimpleFilter> simpleFilters )
throws IOException
{
// remove classes specifically included in filters
Clazzpath checkCp = new Clazzpath();
for ( Artifact dependency : project.getArtifacts() )
{
File jar = dependency.getFile();
for ( SimpleFilter simpleFilter : simpleFilters )
{
if ( simpleFilter.canFilter( jar ) )
{
ClazzpathUnit depClazzpathUnit = addDependencyToClasspath( checkCp, dependency );
if ( depClazzpathUnit != null )
{
Set<Clazz> clazzes = depClazzpathUnit.getClazzes();
for ( final Clazz clazz : new HashSet<>( removable ) )
{
if ( clazzes.contains( clazz ) //
&& simpleFilter.isSpecificallyIncluded( clazz.getName().replace( '.', '/' ) ) )
{
log.debug( clazz.getName() + " not removed because it was specifically included" );
removeClass( clazz );
}
}
}
}
}
}
}
@Override
public boolean canFilter( File jar )
{
return true;
}
@Override
public boolean isFiltered( String classFile )
{
String className = classFile.replace( '/', '.' ).replaceFirst( "\\.class$", "" );
Clazz clazz = new Clazz( className );
if ( removable != null && removable.contains( clazz ) )
{
log.debug( "Removing " + className );
classesRemoved += 1;
return true;
}
classesKept += 1;
return false;
}
@Override
public void finished()
{
int classesTotal = classesRemoved + classesKept;
if ( classesTotal != 0 )
{
log.info( "Minimized " + classesTotal + " -> " + classesKept + " (" + 100 * classesKept / classesTotal
+ "%)" );
}
else
{
log.info( "Minimized " + classesTotal + " -> " + classesKept );
}
}
}