1 | |
package org.apache.maven.shared.filtering; |
2 | |
|
3 | |
|
4 | |
|
5 | |
|
6 | |
|
7 | |
|
8 | |
|
9 | |
|
10 | |
|
11 | |
|
12 | |
|
13 | |
|
14 | |
|
15 | |
|
16 | |
|
17 | |
|
18 | |
|
19 | |
|
20 | |
|
21 | |
|
22 | |
import org.apache.maven.execution.MavenSession; |
23 | |
import org.apache.maven.project.MavenProject; |
24 | |
import org.apache.maven.settings.Settings; |
25 | |
import org.codehaus.plexus.interpolation.InterpolationPostProcessor; |
26 | |
import org.codehaus.plexus.interpolation.PrefixAwareRecursionInterceptor; |
27 | |
import org.codehaus.plexus.interpolation.PrefixedObjectValueSource; |
28 | |
import org.codehaus.plexus.interpolation.PropertiesBasedValueSource; |
29 | |
import org.codehaus.plexus.interpolation.RecursionInterceptor; |
30 | |
import org.codehaus.plexus.interpolation.SimpleRecursionInterceptor; |
31 | |
import org.codehaus.plexus.interpolation.SingleResponseValueSource; |
32 | |
import org.codehaus.plexus.interpolation.ValueSource; |
33 | |
import org.codehaus.plexus.interpolation.multi.MultiDelimiterStringSearchInterpolator; |
34 | |
import org.codehaus.plexus.logging.AbstractLogEnabled; |
35 | |
import org.codehaus.plexus.util.FileUtils; |
36 | |
import org.codehaus.plexus.util.StringUtils; |
37 | |
import org.sonatype.plexus.build.incremental.BuildContext; |
38 | |
|
39 | |
import java.io.File; |
40 | |
import java.io.IOException; |
41 | |
import java.io.Reader; |
42 | |
import java.util.ArrayList; |
43 | |
import java.util.Collections; |
44 | |
import java.util.Iterator; |
45 | |
import java.util.LinkedHashSet; |
46 | |
import java.util.List; |
47 | |
import java.util.Properties; |
48 | |
|
49 | |
|
50 | |
|
51 | |
|
52 | |
|
53 | |
|
54 | |
|
55 | 52 | public class DefaultMavenFileFilter |
56 | |
extends AbstractLogEnabled |
57 | |
implements MavenFileFilter |
58 | |
{ |
59 | |
|
60 | |
|
61 | |
|
62 | |
|
63 | |
private BuildContext buildContext; |
64 | |
|
65 | |
public void copyFile( File from, File to, boolean filtering, MavenProject mavenProject, List<String> filters, |
66 | |
boolean escapedBackslashesInFilePath, String encoding, MavenSession mavenSession ) |
67 | |
throws MavenFilteringException |
68 | |
{ |
69 | 4 | MavenResourcesExecution mre = new MavenResourcesExecution(); |
70 | 4 | mre.setMavenProject( mavenProject ); |
71 | 4 | mre.setFileFilters( filters ); |
72 | 4 | mre.setEscapeWindowsPaths( escapedBackslashesInFilePath ); |
73 | 4 | mre.setMavenSession( mavenSession ); |
74 | 4 | mre.setInjectProjectBuildFilters( true ); |
75 | |
|
76 | 4 | List<FileUtils.FilterWrapper> filterWrappers = getDefaultFilterWrappers( mre ); |
77 | 4 | copyFile( from, to, filtering, filterWrappers, encoding ); |
78 | 4 | } |
79 | |
|
80 | |
|
81 | |
public void copyFile( MavenFileFilterRequest mavenFileFilterRequest ) |
82 | |
throws MavenFilteringException |
83 | |
{ |
84 | 0 | List filterWrappers = getDefaultFilterWrappers( mavenFileFilterRequest ); |
85 | |
|
86 | 0 | copyFile( mavenFileFilterRequest.getFrom(), mavenFileFilterRequest.getTo(), |
87 | |
mavenFileFilterRequest.isFiltering(), filterWrappers, mavenFileFilterRequest.getEncoding() ); |
88 | 0 | } |
89 | |
|
90 | |
|
91 | |
public void copyFile( File from, File to, boolean filtering, List<FileUtils.FilterWrapper> filterWrappers, |
92 | |
String encoding ) |
93 | |
throws MavenFilteringException |
94 | |
{ |
95 | |
|
96 | 10 | copyFile( from, to, filtering, filterWrappers, encoding, false ); |
97 | 10 | } |
98 | |
|
99 | |
|
100 | |
public void copyFile( File from, File to, boolean filtering, List<FileUtils.FilterWrapper> filterWrappers, |
101 | |
String encoding, boolean overwrite ) |
102 | |
throws MavenFilteringException |
103 | |
{ |
104 | |
try |
105 | |
{ |
106 | 154 | if ( filtering ) |
107 | |
{ |
108 | 114 | if ( getLogger().isDebugEnabled() ) |
109 | |
{ |
110 | 0 | getLogger().debug( "filtering " + from.getPath() + " to " + to.getPath() ); |
111 | |
} |
112 | 114 | FileUtils.FilterWrapper[] wrappers = (FileUtils.FilterWrapper[]) filterWrappers.toArray( |
113 | |
new FileUtils.FilterWrapper[filterWrappers.size()] ); |
114 | 114 | FileUtils.copyFile( from, to, encoding, wrappers ); |
115 | 114 | } |
116 | |
else |
117 | |
{ |
118 | 40 | if ( getLogger().isDebugEnabled() ) |
119 | |
{ |
120 | 0 | getLogger().debug( "copy " + from.getPath() + " to " + to.getPath() ); |
121 | |
} |
122 | 40 | FileUtils.copyFile( from, to, encoding, new FileUtils.FilterWrapper[0], overwrite ); |
123 | |
} |
124 | |
|
125 | 154 | buildContext.refresh( to ); |
126 | |
} |
127 | 0 | catch ( IOException e ) |
128 | |
{ |
129 | 0 | throw new MavenFilteringException( e.getMessage(), e ); |
130 | 154 | } |
131 | |
|
132 | 154 | } |
133 | |
|
134 | |
|
135 | |
|
136 | |
|
137 | |
|
138 | |
public List<FileUtils.FilterWrapper> getDefaultFilterWrappers( final MavenProject mavenProject, |
139 | |
List<String> filters, |
140 | |
final boolean escapedBackslashesInFilePath, |
141 | |
MavenSession mavenSession ) |
142 | |
throws MavenFilteringException |
143 | |
{ |
144 | 0 | return getDefaultFilterWrappers( mavenProject, filters, escapedBackslashesInFilePath, mavenSession, null ); |
145 | |
} |
146 | |
|
147 | |
|
148 | |
public List<FileUtils.FilterWrapper> getDefaultFilterWrappers( final MavenProject mavenProject, List<String> filters, |
149 | |
final boolean escapedBackslashesInFilePath, |
150 | |
MavenSession mavenSession, |
151 | |
MavenResourcesExecution mavenResourcesExecution ) |
152 | |
throws MavenFilteringException |
153 | |
{ |
154 | |
|
155 | 2 | MavenResourcesExecution mre = |
156 | |
mavenResourcesExecution == null ? new MavenResourcesExecution() : mavenResourcesExecution.copyOf(); |
157 | |
|
158 | 2 | mre.setMavenProject( mavenProject ); |
159 | 2 | mre.setMavenSession( mavenSession ); |
160 | 2 | mre.setFilters( filters ); |
161 | 2 | mre.setEscapedBackslashesInFilePath( escapedBackslashesInFilePath ); |
162 | |
|
163 | 2 | return getDefaultFilterWrappers( mre ); |
164 | |
|
165 | |
} |
166 | |
|
167 | |
public List<FileUtils.FilterWrapper> getDefaultFilterWrappers( final AbstractMavenFilteringRequest req ) |
168 | |
throws MavenFilteringException |
169 | |
{ |
170 | |
|
171 | 56 | boolean supportMultiLineFiltering = req.isSupportMultiLineFiltering(); |
172 | |
|
173 | |
|
174 | 56 | final AbstractMavenFilteringRequest request = req == null ? new MavenFileFilterRequest() : req; |
175 | |
|
176 | 56 | request.setSupportMultiLineFiltering( supportMultiLineFiltering ); |
177 | |
|
178 | |
|
179 | |
|
180 | |
|
181 | |
|
182 | |
|
183 | |
|
184 | 56 | final Properties baseProps = new Properties(); |
185 | |
|
186 | |
|
187 | 56 | if ( request.getMavenProject() != null ) |
188 | |
{ |
189 | 54 | baseProps.putAll( request.getMavenProject().getProperties() == null |
190 | |
? Collections.emptyMap() |
191 | |
: request.getMavenProject().getProperties() ); |
192 | |
} |
193 | |
|
194 | |
|
195 | 56 | if ( request.getMavenSession() != null ) |
196 | |
{ |
197 | |
|
198 | 54 | baseProps.putAll( request.getMavenSession().getExecutionProperties() ); |
199 | |
} |
200 | |
|
201 | |
|
202 | |
|
203 | 56 | final Properties filterProperties = new Properties(); |
204 | |
|
205 | 56 | loadProperties( filterProperties, request.getFileFilters(), baseProps ); |
206 | 56 | if ( filterProperties.size() < 1 ) |
207 | |
{ |
208 | 36 | filterProperties.putAll( baseProps ); |
209 | |
} |
210 | |
|
211 | 56 | if ( request.getMavenProject() != null ) |
212 | |
{ |
213 | 54 | if ( request.isInjectProjectBuildFilters() ) |
214 | |
{ |
215 | 4 | List<String> buildFilters = new ArrayList( request.getMavenProject().getBuild().getFilters() ); |
216 | 4 | buildFilters.removeAll( request.getFileFilters() ); |
217 | |
|
218 | 4 | loadProperties( filterProperties, buildFilters, baseProps ); |
219 | |
} |
220 | |
|
221 | |
|
222 | 54 | filterProperties.putAll( request.getMavenProject().getProperties() == null |
223 | |
? Collections.emptyMap() |
224 | |
: request.getMavenProject().getProperties() ); |
225 | |
} |
226 | 56 | if ( request.getMavenSession() != null ) |
227 | |
{ |
228 | |
|
229 | 54 | filterProperties.putAll( request.getMavenSession().getExecutionProperties() ); |
230 | |
} |
231 | |
|
232 | 56 | if ( request.getAdditionalProperties() != null ) |
233 | |
{ |
234 | |
|
235 | 2 | filterProperties.putAll( request.getAdditionalProperties() ); |
236 | |
} |
237 | |
|
238 | 56 | List<FileUtils.FilterWrapper> defaultFilterWrappers = request == null |
239 | |
? new ArrayList<FileUtils.FilterWrapper>( 1 ) |
240 | |
: new ArrayList<FileUtils.FilterWrapper>( request.getDelimiters().size() + 1 ); |
241 | |
|
242 | 56 | if ( getLogger().isDebugEnabled() ) |
243 | |
{ |
244 | 0 | getLogger().debug( "properties used " + filterProperties ); |
245 | |
} |
246 | |
|
247 | 56 | final ValueSource propertiesValueSource = new PropertiesBasedValueSource( filterProperties ); |
248 | |
|
249 | 56 | if ( request != null ) |
250 | |
{ |
251 | 56 | FileUtils.FilterWrapper wrapper = |
252 | |
new Wrapper( request.getDelimiters(), request.getMavenProject(), request.getMavenSession(), |
253 | |
propertiesValueSource, request.getProjectStartExpressions(), request.getEscapeString(), |
254 | |
request.isEscapeWindowsPaths(), request.isSupportMultiLineFiltering() ); |
255 | |
|
256 | 56 | defaultFilterWrappers.add( wrapper ); |
257 | |
} |
258 | |
|
259 | 56 | return defaultFilterWrappers; |
260 | |
} |
261 | |
|
262 | |
|
263 | |
|
264 | |
|
265 | |
protected void loadProperties( Properties filterProperties, List<String> propertiesFilePaths, Properties baseProps ) |
266 | |
throws MavenFilteringException |
267 | |
{ |
268 | 62 | if ( propertiesFilePaths != null ) |
269 | |
{ |
270 | 52 | Properties workProperties = new Properties(); |
271 | 52 | workProperties.putAll( baseProps ); |
272 | |
|
273 | 52 | for ( Iterator iterator = propertiesFilePaths.iterator(); iterator.hasNext(); ) |
274 | |
{ |
275 | 42 | String filterFile = (String) iterator.next(); |
276 | 42 | if ( StringUtils.isEmpty( filterFile ) ) |
277 | |
{ |
278 | |
|
279 | 0 | continue; |
280 | |
} |
281 | |
try |
282 | |
{ |
283 | |
|
284 | 42 | Properties properties = PropertyUtils.loadPropertyFile( new File( filterFile ), workProperties ); |
285 | 42 | filterProperties.putAll( properties ); |
286 | 42 | workProperties.putAll( properties ); |
287 | |
} |
288 | 0 | catch ( IOException e ) |
289 | |
{ |
290 | 0 | throw new MavenFilteringException( "Error loading property file '" + filterFile + "'", e ); |
291 | 42 | } |
292 | 42 | } |
293 | |
} |
294 | 62 | } |
295 | |
|
296 | 52 | private static final class Wrapper |
297 | |
extends FileUtils.FilterWrapper |
298 | |
{ |
299 | |
|
300 | |
private LinkedHashSet<String> delimiters; |
301 | |
|
302 | |
private MavenProject project; |
303 | |
|
304 | |
private ValueSource propertiesValueSource; |
305 | |
|
306 | |
private List<String> projectStartExpressions; |
307 | |
|
308 | |
private String escapeString; |
309 | |
|
310 | |
private boolean escapeWindowsPaths; |
311 | |
|
312 | |
private final MavenSession mavenSession; |
313 | |
|
314 | |
private boolean supportMultiLineFiltering; |
315 | |
|
316 | |
Wrapper( LinkedHashSet<String> delimiters, MavenProject project, MavenSession mavenSession, |
317 | |
ValueSource propertiesValueSource, List<String> projectStartExpressions, String escapeString, |
318 | |
boolean escapeWindowsPaths, boolean supportMultiLineFiltering ) |
319 | |
{ |
320 | 56 | super(); |
321 | 56 | this.delimiters = delimiters; |
322 | 56 | this.project = project; |
323 | 56 | this.mavenSession = mavenSession; |
324 | 56 | this.propertiesValueSource = propertiesValueSource; |
325 | 56 | this.projectStartExpressions = projectStartExpressions; |
326 | 56 | this.escapeString = escapeString; |
327 | 56 | this.escapeWindowsPaths = escapeWindowsPaths; |
328 | 56 | this.supportMultiLineFiltering = supportMultiLineFiltering; |
329 | 56 | } |
330 | |
|
331 | |
public Reader getReader( Reader reader ) |
332 | |
{ |
333 | 114 | MultiDelimiterStringSearchInterpolator interpolator = new MultiDelimiterStringSearchInterpolator(); |
334 | 114 | interpolator.setDelimiterSpecs( delimiters ); |
335 | |
|
336 | 114 | RecursionInterceptor ri = null; |
337 | 114 | if ( projectStartExpressions != null && !projectStartExpressions.isEmpty() ) |
338 | |
{ |
339 | 114 | ri = new PrefixAwareRecursionInterceptor( projectStartExpressions, true ); |
340 | |
} |
341 | |
else |
342 | |
{ |
343 | 0 | ri = new SimpleRecursionInterceptor(); |
344 | |
} |
345 | |
|
346 | 114 | interpolator.addValueSource( propertiesValueSource ); |
347 | |
|
348 | 114 | if ( project != null ) |
349 | |
{ |
350 | 114 | interpolator.addValueSource( new PrefixedObjectValueSource( projectStartExpressions, project, true ) ); |
351 | |
} |
352 | |
|
353 | 114 | if ( mavenSession != null ) |
354 | |
{ |
355 | 114 | interpolator.addValueSource( new PrefixedObjectValueSource( "session", mavenSession ) ); |
356 | |
|
357 | 114 | final Settings settings = mavenSession.getSettings(); |
358 | 114 | if ( settings != null ) |
359 | |
{ |
360 | 2 | interpolator.addValueSource( new PrefixedObjectValueSource( "settings", settings ) ); |
361 | 2 | interpolator.addValueSource( |
362 | |
new SingleResponseValueSource( "localRepository", settings.getLocalRepository() ) ); |
363 | |
} |
364 | |
} |
365 | |
|
366 | 114 | interpolator.setEscapeString( escapeString ); |
367 | |
|
368 | 114 | if ( escapeWindowsPaths ) |
369 | |
{ |
370 | 112 | interpolator.addPostProcessor( new InterpolationPostProcessor() |
371 | 112 | { |
372 | |
public Object execute( String expression, Object value ) |
373 | |
{ |
374 | 356 | if ( value instanceof String ) |
375 | |
{ |
376 | 356 | return FilteringUtils.escapeWindowsPath( (String) value ); |
377 | |
} |
378 | |
|
379 | 0 | return value; |
380 | |
} |
381 | |
} ); |
382 | |
} |
383 | |
|
384 | 114 | MultiDelimiterInterpolatorFilterReaderLineEnding filterReader = |
385 | |
new MultiDelimiterInterpolatorFilterReaderLineEnding( reader, interpolator, supportMultiLineFiltering ); |
386 | 114 | filterReader.setRecursionInterceptor( ri ); |
387 | 114 | filterReader.setDelimiterSpecs( delimiters ); |
388 | |
|
389 | 114 | filterReader.setInterpolateWithPrefixPattern( false ); |
390 | 114 | filterReader.setEscapeString( escapeString ); |
391 | |
|
392 | 114 | return filterReader; |
393 | |
} |
394 | |
|
395 | |
} |
396 | |
|
397 | |
} |