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
|
package org.apache.maven.plugin.prefix.internal;
/*
* 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.IOException;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import org.apache.maven.artifact.repository.metadata.Metadata;
import org.apache.maven.artifact.repository.metadata.io.MetadataReader;
import org.apache.maven.model.Build;
import org.apache.maven.model.Plugin;
import org.apache.maven.plugin.BuildPluginManager;
import org.apache.maven.plugin.descriptor.PluginDescriptor;
import org.apache.maven.plugin.prefix.NoPluginFoundForPrefixException;
import org.apache.maven.plugin.prefix.PluginPrefixRequest;
import org.apache.maven.plugin.prefix.PluginPrefixResolver;
import org.apache.maven.plugin.prefix.PluginPrefixResult;
import org.codehaus.plexus.component.annotations.Component;
import org.codehaus.plexus.component.annotations.Requirement;
import org.codehaus.plexus.logging.Logger;
import org.eclipse.aether.RepositoryEvent.EventType;
import org.eclipse.aether.DefaultRepositorySystemSession;
import org.eclipse.aether.RepositoryEvent;
import org.eclipse.aether.RepositoryListener;
import org.eclipse.aether.RepositorySystem;
import org.eclipse.aether.RepositorySystemSession;
import org.eclipse.aether.RequestTrace;
import org.eclipse.aether.metadata.DefaultMetadata;
import org.eclipse.aether.repository.ArtifactRepository;
import org.eclipse.aether.repository.RemoteRepository;
import org.eclipse.aether.repository.RepositoryPolicy;
import org.eclipse.aether.resolution.MetadataRequest;
import org.eclipse.aether.resolution.MetadataResult;
/**
* Resolves a plugin prefix.
*
* @since 3.0
* @author Benjamin Bentmann
*/
@Component( role = PluginPrefixResolver.class )
public class DefaultPluginPrefixResolver
implements PluginPrefixResolver
{
private static final String REPOSITORY_CONTEXT = "plugin";
@Requirement
private Logger logger;
@Requirement
private BuildPluginManager pluginManager;
@Requirement
private RepositorySystem repositorySystem;
@Requirement
private MetadataReader metadataReader;
public PluginPrefixResult resolve( PluginPrefixRequest request )
throws NoPluginFoundForPrefixException
{
logger.debug( "Resolving plugin prefix " + request.getPrefix() + " from " + request.getPluginGroups() );
PluginPrefixResult result = resolveFromProject( request );
if ( result == null )
{
result = resolveFromRepository( request );
if ( result == null )
{
throw new NoPluginFoundForPrefixException( request.getPrefix(), request.getPluginGroups(),
request.getRepositorySession().getLocalRepository(),
request.getRepositories() );
}
else if ( logger.isDebugEnabled() )
{
logger.debug( "Resolved plugin prefix " + request.getPrefix() + " to " + result.getGroupId() + ":"
+ result.getArtifactId() + " from repository "
+ ( result.getRepository() != null ? result.getRepository().getId() : "null" ) );
}
}
else if ( logger.isDebugEnabled() )
{
logger.debug( "Resolved plugin prefix " + request.getPrefix() + " to " + result.getGroupId() + ":"
+ result.getArtifactId() + " from POM " + request.getPom() );
}
return result;
}
private PluginPrefixResult resolveFromProject( PluginPrefixRequest request )
{
PluginPrefixResult result = null;
if ( request.getPom() != null && request.getPom().getBuild() != null )
{
Build build = request.getPom().getBuild();
result = resolveFromProject( request, build.getPlugins() );
if ( result == null && build.getPluginManagement() != null )
{
result = resolveFromProject( request, build.getPluginManagement().getPlugins() );
}
}
return result;
}
private PluginPrefixResult resolveFromProject( PluginPrefixRequest request, List<Plugin> plugins )
{
for ( Plugin plugin : plugins )
{
try
{
PluginDescriptor pluginDescriptor =
pluginManager.loadPlugin( plugin, request.getRepositories(), request.getRepositorySession() );
if ( request.getPrefix().equals( pluginDescriptor.getGoalPrefix() ) )
{
return new DefaultPluginPrefixResult( plugin );
}
}
catch ( Exception e )
{
if ( logger.isDebugEnabled() )
{
logger.warn( "Failed to retrieve plugin descriptor for " + plugin.getId() + ": " + e.getMessage(),
e );
}
else
{
logger.warn( "Failed to retrieve plugin descriptor for " + plugin.getId() + ": " + e.getMessage() );
}
}
}
return null;
}
private PluginPrefixResult resolveFromRepository( PluginPrefixRequest request )
{
RequestTrace trace = RequestTrace.newChild( null, request );
List<MetadataRequest> requests = new ArrayList<MetadataRequest>();
for ( String pluginGroup : request.getPluginGroups() )
{
org.eclipse.aether.metadata.Metadata metadata =
new DefaultMetadata( pluginGroup, "maven-metadata.xml", DefaultMetadata.Nature.RELEASE_OR_SNAPSHOT );
requests.add( new MetadataRequest( metadata, null, REPOSITORY_CONTEXT ).setTrace( trace ) );
for ( RemoteRepository repository : request.getRepositories() )
{
requests.add( new MetadataRequest( metadata, repository, REPOSITORY_CONTEXT ).setTrace( trace ) );
}
}
// initial try, use locally cached metadata
List<MetadataResult> results = repositorySystem.resolveMetadata( request.getRepositorySession(), requests );
requests.clear();
PluginPrefixResult result = processResults( request, trace, results, requests );
if ( result != null )
{
return result;
}
// second try, refetch all (possibly outdated) metadata that wasn't updated in the first attempt
if ( !request.getRepositorySession().isOffline() && !requests.isEmpty() )
{
DefaultRepositorySystemSession session =
new DefaultRepositorySystemSession( request.getRepositorySession() );
session.setUpdatePolicy( RepositoryPolicy.UPDATE_POLICY_ALWAYS );
results = repositorySystem.resolveMetadata( session, requests );
return processResults( request, trace, results, null );
}
return null;
}
private PluginPrefixResult processResults( PluginPrefixRequest request, RequestTrace trace,
List<MetadataResult> results, List<MetadataRequest> requests )
{
for ( MetadataResult res : results )
{
org.eclipse.aether.metadata.Metadata metadata = res.getMetadata();
if ( metadata != null )
{
ArtifactRepository repository = res.getRequest().getRepository();
if ( repository == null )
{
repository = request.getRepositorySession().getLocalRepository();
}
PluginPrefixResult result =
resolveFromRepository( request, trace, metadata.getGroupId(), metadata, repository );
if ( result != null )
{
return result;
}
}
if ( requests != null && !res.isUpdated() )
{
requests.add( res.getRequest() );
}
}
return null;
}
private PluginPrefixResult resolveFromRepository( PluginPrefixRequest request, RequestTrace trace,
String pluginGroup,
org.eclipse.aether.metadata.Metadata metadata,
ArtifactRepository repository )
{
if ( metadata != null && metadata.getFile() != null && metadata.getFile().isFile() )
{
try
{
Map<String, ?> options = Collections.singletonMap( MetadataReader.IS_STRICT, Boolean.FALSE );
Metadata pluginGroupMetadata = metadataReader.read( metadata.getFile(), options );
List<org.apache.maven.artifact.repository.metadata.Plugin> plugins = pluginGroupMetadata.getPlugins();
if ( plugins != null )
{
for ( org.apache.maven.artifact.repository.metadata.Plugin plugin : plugins )
{
if ( request.getPrefix().equals( plugin.getPrefix() ) )
{
return new DefaultPluginPrefixResult( pluginGroup, plugin.getArtifactId(), repository );
}
}
}
}
catch ( IOException e )
{
invalidMetadata( request.getRepositorySession(), trace, metadata, repository, e );
}
}
return null;
}
private void invalidMetadata( RepositorySystemSession session, RequestTrace trace,
org.eclipse.aether.metadata.Metadata metadata, ArtifactRepository repository,
Exception exception )
{
RepositoryListener listener = session.getRepositoryListener();
if ( listener != null )
{
RepositoryEvent.Builder event = new RepositoryEvent.Builder( session, EventType.METADATA_INVALID );
event.setTrace( trace );
event.setMetadata( metadata );
event.setException( exception );
event.setRepository( repository );
listener.metadataInvalid( event.build() );
}
}
}
|
