Coverage Report

Coverage Report - org.apache.maven.plugins.shade.DefaultShader

Classes in this File

Line Coverage

Branch Coverage

Complexity

DefaultShader

72%

84/117

62%

35/56

4,583

DefaultShader$RelocatorRemapper

80%

33/41

78%

14/18

4,583

 package org.apache.maven.plugins.shade;
 
 /*
  * 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 java.io.File;
 import java.io.FileOutputStream;
 import java.io.IOException;
 import java.io.InputStream;
 import java.util.Enumeration;
 import java.util.HashSet;
 import java.util.Iterator;
 import java.util.List;
 import java.util.Set;
 import java.util.ArrayList;
 import java.util.jar.JarEntry;
 import java.util.jar.JarFile;
 import java.util.jar.JarOutputStream;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 import java.util.zip.ZipException;
 
 import org.apache.maven.plugins.shade.relocation.Relocator;
 import org.apache.maven.plugins.shade.resource.ManifestResourceTransformer;
 import org.apache.maven.plugins.shade.resource.ResourceTransformer;
 import org.apache.maven.plugins.shade.filter.Filter;
 import org.codehaus.plexus.logging.AbstractLogEnabled;
 import org.codehaus.plexus.util.IOUtil;
 import org.objectweb.asm.ClassReader;
 import org.objectweb.asm.ClassVisitor;
 import org.objectweb.asm.ClassWriter;
 import org.objectweb.asm.commons.Remapper;
 
 /**
  * @author Jason van Zyl
  * @plexus.component instantiation-strategy="per-lookup"
  */
 public class DefaultShader
     extends AbstractLogEnabled
     implements Shader
 {
 
     public void shade( Set jars, File uberJar, List filters, List relocators, List resourceTransformers )
         throws IOException
     {
         Set resources = new HashSet();
 
         ResourceTransformer manifestTransformer = null;
         List transformers = new ArrayList( resourceTransformers );
         for ( Iterator it = transformers.iterator(); it.hasNext(); )
         {
             ResourceTransformer transformer = (ResourceTransformer) it.next();
             if ( transformer instanceof ManifestResourceTransformer )
             {
                 manifestTransformer = transformer;
                 it.remove();
             }
         }
 
         RelocatorRemapper remapper = new RelocatorRemapper( relocators );
 
         uberJar.getParentFile().mkdirs();
         JarOutputStream jos = new JarOutputStream( new FileOutputStream( uberJar ) );
 
         if ( manifestTransformer != null )
         {
             for ( Iterator it = jars.iterator(); it.hasNext(); )
             {
                 File jar = (File) it.next();
                 JarFile jarFile = newJarFile( jar );
                 for ( Enumeration en = jarFile.entries(); en.hasMoreElements(); )
                 {
                     JarEntry entry = (JarEntry) en.nextElement();
                     String resource = entry.getName();
                     if ( manifestTransformer.canTransformResource( resource ) )
                     {
                         resources.add( resource );
                         manifestTransformer.processResource( resource, jarFile.getInputStream( entry ), relocators );
                         break;
                     }
                 }
             }
             if ( manifestTransformer.hasTransformedResource() )
             {
                 manifestTransformer.modifyOutputStream( jos );
             }
         }
 
         for ( Iterator i = jars.iterator(); i.hasNext(); )
         {
             File jar = (File) i.next();
 
             List jarFilters = getFilters( jar, filters );
 
             JarFile jarFile = newJarFile( jar );
 
             for ( Enumeration j = jarFile.entries(); j.hasMoreElements(); )
             {
                 JarEntry entry = (JarEntry) j.nextElement();
 
                 String name = entry.getName();
 
                 if ( "META-INF/INDEX.LIST".equals( name ) ) 
                 {
                     //we cannot allow the jar indexes to be copied over or the 
                     //jar is useless.   Ideally, we could create a new one
                     //later
                     continue;
                 }
 
                 if ( !entry.isDirectory() && !isFiltered( jarFilters, name ) )
                 {
                     InputStream is = jarFile.getInputStream( entry );
 
                     String mappedName = remapper.map( name );
 
                     int idx = mappedName.lastIndexOf( '/' );
                     if ( idx != -1 )
                     {
                         //make sure dirs are created
                         String dir = mappedName.substring( 0, idx );
                         if ( !resources.contains( dir ) )
                         {
                             addDirectory( resources, jos, dir );
                         }
                     }
 
                     if ( name.endsWith( ".class" ) )
                     {
                         addRemappedClass( remapper, jos, jar, name, is );
                     }
                     else
                     {
                         if ( !resourceTransformed( transformers, mappedName, is, relocators ) )
                         {
                             // Avoid duplicates that aren't accounted for by the resource transformers
                             if ( resources.contains( mappedName ) )
                             {
                                 continue;
                             }
 
                             addResource( resources, jos, mappedName, is );
                         }
                     }
 
                     IOUtil.close( is );
                 }
             }
 
             jarFile.close();
         }
 
         for ( Iterator i = transformers.iterator(); i.hasNext(); )
         {
             ResourceTransformer transformer = (ResourceTransformer) i.next();
 
             if ( transformer.hasTransformedResource() )
             {
                 transformer.modifyOutputStream( jos );
             }
         }
 
         IOUtil.close( jos );
     }
 
     private JarFile newJarFile( File jar )
         throws IOException
     {
         try
         {
             return new JarFile( jar );
         }
         catch ( ZipException zex )
         {
             // JarFile is not very verbose and doesn't tell the user which file it was
             // so we will create a new Exception instead
             throw new ZipException( "error in opening zip file " + jar );
         }
     }
 
     private List getFilters( File jar, List filters )
     {
         List list = new ArrayList();
 
         for ( int i = 0; i < filters.size(); i++ )
         {
             Filter filter = (Filter) filters.get( i );
 
             if ( filter.canFilter( jar ) )
             {
                 list.add( filter );
             }
 
         }
 
         return list;
     }
 
     private void addDirectory( Set resources, JarOutputStream jos, String name )
         throws IOException
     {
         if ( name.lastIndexOf( '/' ) > 0 )
         {
             String parent = name.substring( 0, name.lastIndexOf( '/' ) );
             if ( !resources.contains( parent ) )
             {
                 addDirectory( resources, jos, parent );
             }
         }
 
         //directory entries must end in "/"
         JarEntry entry = new JarEntry( name + "/" );
         jos.putNextEntry( entry );
 
         resources.add( name );
     }
 
     private void addRemappedClass( RelocatorRemapper remapper, JarOutputStream jos, File jar, String name,
                                    InputStream is )
         throws IOException
     {
         if ( !remapper.hasRelocators() )
         {
             try
             {
                 jos.putNextEntry( new JarEntry( name ) );
                 IOUtil.copy( is, jos );
             }
             catch ( ZipException e )
             {
                 getLogger().warn( "We have a duplicate " + name + " in " + jar );
             }
 
             return;
         }
 
         ClassReader cr = new ClassReader( is );
 
         ClassWriter cw = new ClassWriter( cr, 0 );
 
         ClassVisitor cv = new TempRemappingClassAdapter( cw, remapper );
 
         cr.accept( cv, ClassReader.EXPAND_FRAMES );
 
         byte[] renamedClass = cw.toByteArray();
 
         // Need to take the .class off for remapping evaluation
         String mappedName = remapper.map( name.substring( 0, name.indexOf( '.' ) ) );
 
         try
         {
             // Now we put it back on so the class file is written out with the right extension.
             jos.putNextEntry( new JarEntry( mappedName + ".class" ) );
 
             IOUtil.copy( renamedClass, jos );
         }
         catch ( ZipException e )
         {
             getLogger().warn( "We have a duplicate " + mappedName + " in " + jar );
         }
     }
 
     private boolean isFiltered( List filters, String name )
     {
         for ( int i = 0; i < filters.size(); i++ )
         {
             Filter filter = (Filter) filters.get( i );
 
             if ( filter.isFiltered( name ) )
             {
                 return true;
             }
         }
 
         return false;
     }
 
     private boolean resourceTransformed( List resourceTransformers, String name, InputStream is, List relocators )
         throws IOException
     {
         boolean resourceTransformed = false;
 
         for ( Iterator k = resourceTransformers.iterator(); k.hasNext(); )
         {
             ResourceTransformer transformer = (ResourceTransformer) k.next();
 
             if ( transformer.canTransformResource( name ) )
             {
                 transformer.processResource( name, is, relocators );
 
                 resourceTransformed = true;
 
                 break;
             }
         }
         return resourceTransformed;
     }
 
     private void addResource( Set resources, JarOutputStream jos, String name, InputStream is )
         throws IOException
     {
         jos.putNextEntry( new JarEntry( name ) );
 
         IOUtil.copy( is, jos );
 
         resources.add( name );
     }
 
     class RelocatorRemapper
         extends Remapper
     {
 
         private final Pattern classPattern = Pattern.compile( "(\\[*)?L(.+);" );
 
         List relocators;
 
         public RelocatorRemapper( List relocators )
         {
             this.relocators = relocators;
         }
 
         public boolean hasRelocators()
         {
             return !relocators.isEmpty();
         }
 
         public Object mapValue( Object object )
         {
             if ( object instanceof String )
             {
                 String name = (String) object;
                 String value = name;
 
                 String prefix = "";
                 String suffix = "";
 
                 Matcher m = classPattern.matcher( name );
                 if ( m.matches() )
                 {
                     prefix = m.group( 1 ) + "L";
                     suffix = ";";
                     name = m.group( 2 );
                 }
 
                 for ( Iterator i = relocators.iterator(); i.hasNext(); )
                 {
                     Relocator r = (Relocator) i.next();
 
                     if ( r.canRelocateClass( name ) )
                     {
                         value = prefix + r.relocateClass( name ) + suffix;
                         break;
                     }
                     else if ( r.canRelocatePath( name ) )
                     {
                         value = prefix + r.relocatePath( name ) + suffix;
                         break;
                     }
                 }
 
                 return value;
             }
 
             return super.mapValue( object );
         }
 
         public String map( String name )
         {
             String value = name;
 
             String prefix = "";
             String suffix = "";
 
             Matcher m = classPattern.matcher( name );
             if ( m.matches() )
             {
                 prefix = m.group( 1 ) + "L";
                 suffix = ";";
                 name = m.group( 2 );
             }
 
             for ( Iterator i = relocators.iterator(); i.hasNext(); )
             {
                 Relocator r = (Relocator) i.next();
 
                 if ( r.canRelocatePath( name ) )
                 {
                     value = prefix + r.relocatePath( name ) + suffix;
                     break;
                 }
             }
 
             return value;
         }
 
     }
 
 }

1		package org.apache.maven.plugins.shade;
2
3		/*
4		* Licensed to the Apache Software Foundation (ASF) under one
5		* or more contributor license agreements. See the NOTICE file
6		* distributed with this work for additional information
7		* regarding copyright ownership. The ASF licenses this file
8		* to you under the Apache License, Version 2.0 (the
9		* "License"); you may not use this file except in compliance
10		* with the License. You may obtain a copy of the License at
11		*
12		* http://www.apache.org/licenses/LICENSE-2.0
13		*
14		* Unless required by applicable law or agreed to in writing,
15		* software distributed under the License is distributed on an
16		* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17		* KIND, either express or implied. See the License for the
18		* specific language governing permissions and limitations
19		* under the License.
20		*/
21
22		import java.io.File;
23		import java.io.FileOutputStream;
24		import java.io.IOException;
25		import java.io.InputStream;
26		import java.util.Enumeration;
27		import java.util.HashSet;
28		import java.util.Iterator;
29		import java.util.List;
30		import java.util.Set;
31		import java.util.ArrayList;
32		import java.util.jar.JarEntry;
33		import java.util.jar.JarFile;
34		import java.util.jar.JarOutputStream;
35		import java.util.regex.Matcher;
36		import java.util.regex.Pattern;
37		import java.util.zip.ZipException;
38
39		import org.apache.maven.plugins.shade.relocation.Relocator;
40		import org.apache.maven.plugins.shade.resource.ManifestResourceTransformer;
41		import org.apache.maven.plugins.shade.resource.ResourceTransformer;
42		import org.apache.maven.plugins.shade.filter.Filter;
43		import org.codehaus.plexus.logging.AbstractLogEnabled;
44		import org.codehaus.plexus.util.IOUtil;
45		import org.objectweb.asm.ClassReader;
46		import org.objectweb.asm.ClassVisitor;
47		import org.objectweb.asm.ClassWriter;
48		import org.objectweb.asm.commons.Remapper;
49
50		/**
51		* @author Jason van Zyl
52		* @plexus.component instantiation-strategy="per-lookup"
53		*/
54	7	public class DefaultShader
55		extends AbstractLogEnabled
56		implements Shader
57		{
58
59		public void shade( Set jars, File uberJar, List filters, List relocators, List resourceTransformers )
60		throws IOException
61		{
62	7	Set resources = new HashSet();
63
64	7	ResourceTransformer manifestTransformer = null;
65	7	List transformers = new ArrayList( resourceTransformers );
66	7	for ( Iterator it = transformers.iterator(); it.hasNext(); )
67		{
68	5	ResourceTransformer transformer = (ResourceTransformer) it.next();
69	5	if ( transformer instanceof ManifestResourceTransformer )
70		{
71	0	manifestTransformer = transformer;
72	0	it.remove();
73		}
74	5	}
75
76	7	RelocatorRemapper remapper = new RelocatorRemapper( relocators );
77
78	7	uberJar.getParentFile().mkdirs();
79	7	JarOutputStream jos = new JarOutputStream( new FileOutputStream( uberJar ) );
80
81	7	if ( manifestTransformer != null )
82		{
83	0	for ( Iterator it = jars.iterator(); it.hasNext(); )
84		{
85	0	File jar = (File) it.next();
86	0	JarFile jarFile = newJarFile( jar );
87	0	for ( Enumeration en = jarFile.entries(); en.hasMoreElements(); )
88		{
89	0	JarEntry entry = (JarEntry) en.nextElement();
90	0	String resource = entry.getName();
91	0	if ( manifestTransformer.canTransformResource( resource ) )
92		{
93	0	resources.add( resource );
94	0	manifestTransformer.processResource( resource, jarFile.getInputStream( entry ), relocators );
95	0	break;
96		}
97	0	}
98	0	}
99	0	if ( manifestTransformer.hasTransformedResource() )
100		{
101	0	manifestTransformer.modifyOutputStream( jos );
102		}
103		}
104
105	7	for ( Iterator i = jars.iterator(); i.hasNext(); )
106		{
107	12	File jar = (File) i.next();
108
109	12	List jarFilters = getFilters( jar, filters );
110
111	12	JarFile jarFile = newJarFile( jar );
112
113	12	for ( Enumeration j = jarFile.entries(); j.hasMoreElements(); )
114		{
115	631	JarEntry entry = (JarEntry) j.nextElement();
116
117	631	String name = entry.getName();
118
119	631	if ( "META-INF/INDEX.LIST".equals( name ) )
120		{
121		//we cannot allow the jar indexes to be copied over or the
122		//jar is useless. Ideally, we could create a new one
123		//later
124	0	continue;
125		}
126
127	631	if ( !entry.isDirectory() && !isFiltered( jarFilters, name ) )
128		{
129	483	InputStream is = jarFile.getInputStream( entry );
130
131	483	String mappedName = remapper.map( name );
132
133	483	int idx = mappedName.lastIndexOf( '/' );
134	483	if ( idx != -1 )
135		{
136		//make sure dirs are created
137	483	String dir = mappedName.substring( 0, idx );
138	483	if ( !resources.contains( dir ) )
139		{
140	81	addDirectory( resources, jos, dir );
141		}
142		}
143
144	483	if ( name.endsWith( ".class" ) )
145		{
146	422	addRemappedClass( remapper, jos, jar, name, is );
147		}
148		else
149		{
150	61	if ( !resourceTransformed( transformers, mappedName, is, relocators ) )
151		{
152		// Avoid duplicates that aren't accounted for by the resource transformers
153	56	if ( resources.contains( mappedName ) )
154		{
155	5	continue;
156		}
157
158	51	addResource( resources, jos, mappedName, is );
159		}
160		}
161
162	478	IOUtil.close( is );
163		}
164	626	}
165
166	12	jarFile.close();
167	12	}
168
169	7	for ( Iterator i = transformers.iterator(); i.hasNext(); )
170		{
171	5	ResourceTransformer transformer = (ResourceTransformer) i.next();
172
173	5	if ( transformer.hasTransformedResource() )
174		{
175	5	transformer.modifyOutputStream( jos );
176		}
177	5	}
178
179	7	IOUtil.close( jos );
180	7	}
181
182		private JarFile newJarFile( File jar )
183		throws IOException
184		{
185		try
186		{
187	12	return new JarFile( jar );
188		}
189	0	catch ( ZipException zex )
190		{
191		// JarFile is not very verbose and doesn't tell the user which file it was
192		// so we will create a new Exception instead
193	0	throw new ZipException( "error in opening zip file " + jar );
194		}
195		}
196
197		private List getFilters( File jar, List filters )
198		{
199	12	List list = new ArrayList();
200
201	12	for ( int i = 0; i < filters.size(); i++ )
202		{
203	0	Filter filter = (Filter) filters.get( i );
204
205	0	if ( filter.canFilter( jar ) )
206		{
207	0	list.add( filter );
208		}
209
210		}
211
212	12	return list;
213		}
214
215		private void addDirectory( Set resources, JarOutputStream jos, String name )
216		throws IOException
217		{
218	150	if ( name.lastIndexOf( '/' ) > 0 )
219		{
220	129	String parent = name.substring( 0, name.lastIndexOf( '/' ) );
221	129	if ( !resources.contains( parent ) )
222		{
223	69	addDirectory( resources, jos, parent );
224		}
225		}
226
227		//directory entries must end in "/"
228	150	JarEntry entry = new JarEntry( name + "/" );
229	150	jos.putNextEntry( entry );
230
231	150	resources.add( name );
232	150	}
233
234		private void addRemappedClass( RelocatorRemapper remapper, JarOutputStream jos, File jar, String name,
235		InputStream is )
236		throws IOException
237		{
238	422	if ( !remapper.hasRelocators() )
239		{
240		try
241		{
242	0	jos.putNextEntry( new JarEntry( name ) );
243	0	IOUtil.copy( is, jos );
244		}
245	0	catch ( ZipException e )
246		{
247	0	getLogger().warn( "We have a duplicate " + name + " in " + jar );
248	0	}
249
250	0	return;
251		}
252
253	422	ClassReader cr = new ClassReader( is );
254
255	422	ClassWriter cw = new ClassWriter( cr, 0 );
256
257	422	ClassVisitor cv = new TempRemappingClassAdapter( cw, remapper );
258
259	422	cr.accept( cv, ClassReader.EXPAND_FRAMES );
260
261	422	byte[] renamedClass = cw.toByteArray();
262
263		// Need to take the .class off for remapping evaluation
264	422	String mappedName = remapper.map( name.substring( 0, name.indexOf( '.' ) ) );
265
266		try
267		{
268		// Now we put it back on so the class file is written out with the right extension.
269	422	jos.putNextEntry( new JarEntry( mappedName + ".class" ) );
270
271	422	IOUtil.copy( renamedClass, jos );
272		}
273	0	catch ( ZipException e )
274		{
275	0	getLogger().warn( "We have a duplicate " + mappedName + " in " + jar );
276	422	}
277	422	}
278
279		private boolean isFiltered( List filters, String name )
280		{
281	483	for ( int i = 0; i < filters.size(); i++ )
282		{
283	0	Filter filter = (Filter) filters.get( i );
284
285	0	if ( filter.isFiltered( name ) )
286		{
287	0	return true;
288		}
289		}
290
291	483	return false;
292		}
293
294		private boolean resourceTransformed( List resourceTransformers, String name, InputStream is, List relocators )
295		throws IOException
296		{
297	61	boolean resourceTransformed = false;
298
299	61	for ( Iterator k = resourceTransformers.iterator(); k.hasNext(); )
300		{
301	55	ResourceTransformer transformer = (ResourceTransformer) k.next();
302
303	55	if ( transformer.canTransformResource( name ) )
304		{
305	5	transformer.processResource( name, is, relocators );
306
307	5	resourceTransformed = true;
308
309	5	break;
310		}
311	50	}
312	61	return resourceTransformed;
313		}
314
315		private void addResource( Set resources, JarOutputStream jos, String name, InputStream is )
316		throws IOException
317		{
318	51	jos.putNextEntry( new JarEntry( name ) );
319
320	51	IOUtil.copy( is, jos );
321
322	51	resources.add( name );
323	51	}
324
325	7	class RelocatorRemapper
326		extends Remapper
327		{
328
329	7	private final Pattern classPattern = Pattern.compile( "(\\[*)?L(.+);" );
330
331		List relocators;
332
333		public RelocatorRemapper( List relocators )
334	7	{
335	7	this.relocators = relocators;
336	7	}
337
338		public boolean hasRelocators()
339		{
340	422	return !relocators.isEmpty();
341		}
342
343		public Object mapValue( Object object )
344		{
345	8212	if ( object instanceof String )
346		{
347	4603	String name = (String) object;
348	4603	String value = name;
349
350	4603	String prefix = "";
351	4603	String suffix = "";
352
353	4603	Matcher m = classPattern.matcher( name );
354	4603	if ( m.matches() )
355		{
356	0	prefix = m.group( 1 ) + "L";
357	0	suffix = ";";
358	0	name = m.group( 2 );
359		}
360
361	4603	for ( Iterator i = relocators.iterator(); i.hasNext(); )
362		{
363	4603	Relocator r = (Relocator) i.next();
364
365	4603	if ( r.canRelocateClass( name ) )
366		{
367	1	value = prefix + r.relocateClass( name ) + suffix;
368	1	break;
369		}
370	4602	else if ( r.canRelocatePath( name ) )
371		{
372	0	value = prefix + r.relocatePath( name ) + suffix;
373	0	break;
374		}
375	4602	}
376
377	4603	return value;
378		}
379
380	3609	return super.mapValue( object );
381		}
382
383		public String map( String name )
384		{
385	101893	String value = name;
386
387	101893	String prefix = "";
388	101893	String suffix = "";
389
390	101893	Matcher m = classPattern.matcher( name );
391	101893	if ( m.matches() )
392		{
393	0	prefix = m.group( 1 ) + "L";
394	0	suffix = ";";
395	0	name = m.group( 2 );
396		}
397
398	101893	for ( Iterator i = relocators.iterator(); i.hasNext(); )
399		{
400	101893	Relocator r = (Relocator) i.next();
401
402	101893	if ( r.canRelocatePath( name ) )
403		{
404	20935	value = prefix + r.relocatePath( name ) + suffix;
405	20935	break;
406		}
407	80958	}
408
409	101893	return value;
410		}
411
412		}
413
414		}