1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19 package org.apache.maven.impl.resolver;
20
21 import java.io.IOException;
22 import java.io.InputStream;
23 import java.nio.file.Files;
24 import java.nio.file.Path;
25 import java.util.ArrayList;
26 import java.util.Collections;
27 import java.util.HashMap;
28 import java.util.List;
29 import java.util.Map;
30 import java.util.Objects;
31
32 import org.apache.maven.api.Constants;
33 import org.apache.maven.api.di.Inject;
34 import org.apache.maven.api.di.Named;
35 import org.apache.maven.api.di.Singleton;
36 import org.apache.maven.api.metadata.Snapshot;
37 import org.apache.maven.api.metadata.SnapshotVersion;
38 import org.apache.maven.api.metadata.Versioning;
39 import org.apache.maven.metadata.v4.MetadataStaxReader;
40 import org.eclipse.aether.RepositoryCache;
41 import org.eclipse.aether.RepositoryEvent;
42 import org.eclipse.aether.RepositoryEvent.EventType;
43 import org.eclipse.aether.RepositorySystemSession;
44 import org.eclipse.aether.RequestTrace;
45 import org.eclipse.aether.SyncContext;
46 import org.eclipse.aether.artifact.Artifact;
47 import org.eclipse.aether.impl.MetadataResolver;
48 import org.eclipse.aether.impl.RepositoryEventDispatcher;
49 import org.eclipse.aether.impl.VersionResolver;
50 import org.eclipse.aether.metadata.DefaultMetadata;
51 import org.eclipse.aether.metadata.Metadata;
52 import org.eclipse.aether.repository.ArtifactRepository;
53 import org.eclipse.aether.repository.LocalRepository;
54 import org.eclipse.aether.repository.RemoteRepository;
55 import org.eclipse.aether.repository.WorkspaceReader;
56 import org.eclipse.aether.repository.WorkspaceRepository;
57 import org.eclipse.aether.resolution.MetadataRequest;
58 import org.eclipse.aether.resolution.MetadataResult;
59 import org.eclipse.aether.resolution.VersionRequest;
60 import org.eclipse.aether.resolution.VersionResolutionException;
61 import org.eclipse.aether.resolution.VersionResult;
62 import org.eclipse.aether.spi.synccontext.SyncContextFactory;
63 import org.eclipse.aether.util.ConfigUtils;
64
65
66
67 @Named
68 @Singleton
69 public class DefaultVersionResolver implements VersionResolver {
70
71 private static final String MAVEN_METADATA_XML = "maven-metadata.xml";
72
73 private static final String RELEASE = "RELEASE";
74
75 private static final String LATEST = "LATEST";
76
77 private static final String SNAPSHOT = "SNAPSHOT";
78
79 private final MetadataResolver metadataResolver;
80 private final SyncContextFactory syncContextFactory;
81 private final RepositoryEventDispatcher repositoryEventDispatcher;
82
83 @Inject
84 public DefaultVersionResolver(
85 MetadataResolver metadataResolver,
86 SyncContextFactory syncContextFactory,
87 RepositoryEventDispatcher repositoryEventDispatcher) {
88 this.metadataResolver = Objects.requireNonNull(metadataResolver, "metadataResolver cannot be null");
89 this.syncContextFactory = Objects.requireNonNull(syncContextFactory, "syncContextFactory cannot be null");
90 this.repositoryEventDispatcher =
91 Objects.requireNonNull(repositoryEventDispatcher, "repositoryEventDispatcher cannot be null");
92 }
93
94 @SuppressWarnings("checkstyle:methodlength")
95 @Override
96 public VersionResult resolveVersion(RepositorySystemSession session, VersionRequest request)
97 throws VersionResolutionException {
98 RequestTrace trace = RequestTrace.newChild(request.getTrace(), request);
99
100 Artifact artifact = request.getArtifact();
101
102 String version = artifact.getVersion();
103
104 VersionResult result = new VersionResult(request);
105
106 Key cacheKey = null;
107 RepositoryCache cache = session.getCache();
108 if (cache != null && !ConfigUtils.getBoolean(session, false, Constants.MAVEN_VERSION_RESOLVER_NO_CACHE)) {
109 cacheKey = new Key(session, request);
110
111 Object obj = cache.get(session, cacheKey);
112 if (obj instanceof Record record) {
113 result.setVersion(record.version);
114 result.setRepository(
115 getRepository(session, request.getRepositories(), record.repoClass, record.repoId));
116 return result;
117 }
118 }
119
120 Metadata metadata;
121
122 if (RELEASE.equals(version)) {
123 metadata = new DefaultMetadata(
124 artifact.getGroupId(), artifact.getArtifactId(), MAVEN_METADATA_XML, Metadata.Nature.RELEASE);
125 } else if (LATEST.equals(version)) {
126 metadata = new DefaultMetadata(
127 artifact.getGroupId(),
128 artifact.getArtifactId(),
129 MAVEN_METADATA_XML,
130 Metadata.Nature.RELEASE_OR_SNAPSHOT);
131 } else if (version.endsWith(SNAPSHOT)) {
132 WorkspaceReader workspace = session.getWorkspaceReader();
133 if (workspace != null && workspace.findVersions(artifact).contains(version)) {
134 metadata = null;
135 result.setRepository(workspace.getRepository());
136 } else {
137 metadata = new DefaultMetadata(
138 artifact.getGroupId(),
139 artifact.getArtifactId(),
140 version,
141 MAVEN_METADATA_XML,
142 Metadata.Nature.SNAPSHOT);
143 }
144 } else {
145 metadata = null;
146 }
147
148 if (metadata == null) {
149 result.setVersion(version);
150 } else {
151 List<MetadataRequest> metadataReqs =
152 new ArrayList<>(request.getRepositories().size());
153
154 metadataReqs.add(new MetadataRequest(metadata, null, request.getRequestContext()));
155
156 for (RemoteRepository repository : request.getRepositories()) {
157 MetadataRequest metadataRequest =
158 new MetadataRequest(metadata, repository, request.getRequestContext());
159 metadataRequest.setDeleteLocalCopyIfMissing(true);
160 metadataRequest.setFavorLocalRepository(true);
161 metadataRequest.setTrace(trace);
162 metadataReqs.add(metadataRequest);
163 }
164
165 List<MetadataResult> metadataResults = metadataResolver.resolveMetadata(session, metadataReqs);
166
167 Map<String, VersionInfo> infos = new HashMap<>();
168
169 for (MetadataResult metadataResult : metadataResults) {
170 result.addException(metadataResult.getException());
171
172 ArtifactRepository repository = metadataResult.getRequest().getRepository();
173 if (repository == null) {
174 repository = session.getLocalRepository();
175 }
176
177 Versioning v = readVersions(session, trace, metadataResult.getMetadata(), repository, result);
178 merge(artifact, infos, v, repository);
179 }
180
181 if (RELEASE.equals(version)) {
182 resolve(result, infos, RELEASE);
183 } else if (LATEST.equals(version)) {
184 if (!resolve(result, infos, LATEST)) {
185 resolve(result, infos, RELEASE);
186 }
187
188 if (result.getVersion() != null && result.getVersion().endsWith(SNAPSHOT)) {
189 VersionRequest subRequest = new VersionRequest();
190 subRequest.setArtifact(artifact.setVersion(result.getVersion()));
191 if (result.getRepository() instanceof RemoteRepository r) {
192 subRequest.setRepositories(Collections.singletonList(r));
193 } else {
194 subRequest.setRepositories(request.getRepositories());
195 }
196 VersionResult subResult = resolveVersion(session, subRequest);
197 result.setVersion(subResult.getVersion());
198 result.setRepository(subResult.getRepository());
199 for (Exception exception : subResult.getExceptions()) {
200 result.addException(exception);
201 }
202 }
203 } else {
204 String key = SNAPSHOT + getKey(artifact.getClassifier(), artifact.getExtension());
205 merge(infos, SNAPSHOT, key);
206 if (!resolve(result, infos, key)) {
207 result.setVersion(version);
208 }
209 }
210
211 if (result.getVersion() == null || result.getVersion().isEmpty()) {
212 throw new VersionResolutionException(result);
213 }
214 }
215
216 if (cacheKey != null && metadata != null && isSafelyCacheable(session, artifact)) {
217 cache.put(session, cacheKey, new Record(result.getVersion(), result.getRepository()));
218 }
219
220 return result;
221 }
222
223 private boolean resolve(VersionResult result, Map<String, VersionInfo> infos, String key) {
224 VersionInfo info = infos.get(key);
225 if (info != null) {
226 result.setVersion(info.version);
227 result.setRepository(info.repository);
228 }
229 return info != null;
230 }
231
232 private Versioning readVersions(
233 RepositorySystemSession session,
234 RequestTrace trace,
235 Metadata metadata,
236 ArtifactRepository repository,
237 VersionResult result) {
238 Versioning versioning = null;
239 try {
240 if (metadata != null) {
241 try (SyncContext syncContext = syncContextFactory.newInstance(session, true)) {
242 syncContext.acquire(null, Collections.singleton(metadata));
243
244 if (metadata.getPath() != null && Files.exists(metadata.getPath())) {
245 try (InputStream in = Files.newInputStream(metadata.getPath())) {
246 versioning =
247 new MetadataStaxReader().read(in, false).getVersioning();
248
249
250
251
252
253
254 if (versioning != null
255 && repository instanceof LocalRepository
256 && versioning.getSnapshot() != null
257 && versioning.getSnapshot().getBuildNumber() > 0) {
258 versioning = Versioning.newBuilder()
259 .lastUpdated(versioning.getLastUpdated())
260 .snapshot(Snapshot.newBuilder()
261 .localCopy(true)
262 .build())
263 .build();
264 throw new IOException("Snapshot information corrupted with remote repository data"
265 + ", please verify that no remote repository uses the id '"
266 + repository.getId() + "'");
267 }
268 }
269 }
270 }
271 }
272 } catch (Exception e) {
273 invalidMetadata(session, trace, metadata, repository, e);
274 result.addException(e);
275 }
276
277 return (versioning != null) ? versioning : Versioning.newInstance();
278 }
279
280 private void invalidMetadata(
281 RepositorySystemSession session,
282 RequestTrace trace,
283 Metadata metadata,
284 ArtifactRepository repository,
285 Exception exception) {
286 RepositoryEvent.Builder event = new RepositoryEvent.Builder(session, EventType.METADATA_INVALID);
287 event.setTrace(trace);
288 event.setMetadata(metadata);
289 event.setException(exception);
290 event.setRepository(repository);
291
292 repositoryEventDispatcher.dispatch(event.build());
293 }
294
295 private void merge(
296 Artifact artifact, Map<String, VersionInfo> infos, Versioning versioning, ArtifactRepository repository) {
297 if (versioning.getRelease() != null && !versioning.getRelease().isEmpty()) {
298 merge(RELEASE, infos, versioning.getLastUpdated(), versioning.getRelease(), repository);
299 }
300
301 if (versioning.getLatest() != null && !versioning.getLatest().isEmpty()) {
302 merge(LATEST, infos, versioning.getLastUpdated(), versioning.getLatest(), repository);
303 }
304
305 for (SnapshotVersion sv : versioning.getSnapshotVersions()) {
306 if (sv.getVersion() != null && !sv.getVersion().isEmpty()) {
307 String key = getKey(sv.getClassifier(), sv.getExtension());
308 merge(SNAPSHOT + key, infos, sv.getUpdated(), sv.getVersion(), repository);
309 }
310 }
311
312 Snapshot snapshot = versioning.getSnapshot();
313 if (snapshot != null && versioning.getSnapshotVersions().isEmpty()) {
314 String version = artifact.getVersion();
315 if (snapshot.getTimestamp() != null && snapshot.getBuildNumber() > 0) {
316 String qualifier = snapshot.getTimestamp() + '-' + snapshot.getBuildNumber();
317 version = version.substring(0, version.length() - SNAPSHOT.length()) + qualifier;
318 }
319 merge(SNAPSHOT, infos, versioning.getLastUpdated(), version, repository);
320 }
321 }
322
323 private void merge(
324 String key,
325 Map<String, VersionInfo> infos,
326 String timestamp,
327 String version,
328 ArtifactRepository repository) {
329 VersionInfo info = infos.get(key);
330 if (info == null) {
331 info = new VersionInfo(timestamp, version, repository);
332 infos.put(key, info);
333 } else if (info.isOutdated(timestamp)) {
334 info.version = version;
335 info.repository = repository;
336 info.timestamp = timestamp;
337 }
338 }
339
340 private void merge(Map<String, VersionInfo> infos, String srcKey, String dstKey) {
341 VersionInfo srcInfo = infos.get(srcKey);
342 VersionInfo dstInfo = infos.get(dstKey);
343
344 if (dstInfo == null
345 || (srcInfo != null
346 && dstInfo.isOutdated(srcInfo.timestamp)
347 && srcInfo.repository != dstInfo.repository)) {
348 infos.put(dstKey, srcInfo);
349 }
350 }
351
352 private String getKey(String classifier, String extension) {
353 return (classifier == null ? "" : classifier.trim()) + ':' + (extension == null ? "" : extension.trim());
354 }
355
356 private ArtifactRepository getRepository(
357 RepositorySystemSession session, List<RemoteRepository> repositories, Class<?> repoClass, String repoId) {
358 if (repoClass != null) {
359 if (WorkspaceRepository.class.isAssignableFrom(repoClass)) {
360 return session.getWorkspaceReader().getRepository();
361 } else if (LocalRepository.class.isAssignableFrom(repoClass)) {
362 return session.getLocalRepository();
363 } else {
364 for (RemoteRepository repository : repositories) {
365 if (repoId.equals(repository.getId())) {
366 return repository;
367 }
368 }
369 }
370 }
371 return null;
372 }
373
374 private boolean isSafelyCacheable(RepositorySystemSession session, Artifact artifact) {
375
376
377
378
379
380 WorkspaceReader workspace = session.getWorkspaceReader();
381 if (workspace == null) {
382 return true;
383 }
384
385 Artifact pomArtifact = ArtifactDescriptorUtils.toPomArtifact(artifact);
386
387 return workspace.findArtifact(pomArtifact) == null;
388 }
389
390 private static class VersionInfo {
391
392 String timestamp;
393
394 String version;
395
396 ArtifactRepository repository;
397
398 VersionInfo(String timestamp, String version, ArtifactRepository repository) {
399 this.timestamp = (timestamp != null) ? timestamp : "";
400 this.version = version;
401 this.repository = repository;
402 }
403
404 boolean isOutdated(String timestamp) {
405 return timestamp != null && timestamp.compareTo(this.timestamp) > 0;
406 }
407 }
408
409 private static class Key {
410
411 private final String groupId;
412
413 private final String artifactId;
414
415 private final String classifier;
416
417 private final String extension;
418
419 private final String version;
420
421 private final String context;
422
423 private final Path localRepo;
424
425 private final WorkspaceRepository workspace;
426
427 private final List<RemoteRepository> repositories;
428
429 private final int hashCode;
430
431 Key(RepositorySystemSession session, VersionRequest request) {
432 Artifact artifact = request.getArtifact();
433 groupId = artifact.getGroupId();
434 artifactId = artifact.getArtifactId();
435 classifier = artifact.getClassifier();
436 extension = artifact.getExtension();
437 version = artifact.getVersion();
438 localRepo = session.getLocalRepository().getBasePath();
439 WorkspaceReader reader = session.getWorkspaceReader();
440 workspace = (reader != null) ? reader.getRepository() : null;
441 repositories = new ArrayList<>(request.getRepositories().size());
442 boolean repoMan = false;
443 for (RemoteRepository repository : request.getRepositories()) {
444 if (repository.isRepositoryManager()) {
445 repoMan = true;
446 repositories.addAll(repository.getMirroredRepositories());
447 } else {
448 repositories.add(repository);
449 }
450 }
451 context = repoMan ? request.getRequestContext() : "";
452
453 int hash = 17;
454 hash = hash * 31 + groupId.hashCode();
455 hash = hash * 31 + artifactId.hashCode();
456 hash = hash * 31 + classifier.hashCode();
457 hash = hash * 31 + extension.hashCode();
458 hash = hash * 31 + version.hashCode();
459 hash = hash * 31 + localRepo.hashCode();
460 hash = hash * 31 + repositories.hashCode();
461 hashCode = hash;
462 }
463
464 @Override
465 public boolean equals(Object obj) {
466 if (obj == this) {
467 return true;
468 } else if (obj == null || !getClass().equals(obj.getClass())) {
469 return false;
470 }
471
472 Key that = (Key) obj;
473 return artifactId.equals(that.artifactId)
474 && groupId.equals(that.groupId)
475 && classifier.equals(that.classifier)
476 && extension.equals(that.extension)
477 && version.equals(that.version)
478 && context.equals(that.context)
479 && localRepo.equals(that.localRepo)
480 && Objects.equals(workspace, that.workspace)
481 && repositories.equals(that.repositories);
482 }
483
484 @Override
485 public int hashCode() {
486 return hashCode;
487 }
488 }
489
490 private static class Record {
491 final String version;
492
493 final String repoId;
494
495 final Class<?> repoClass;
496
497 Record(String version, ArtifactRepository repository) {
498 this.version = version;
499 if (repository != null) {
500 repoId = repository.getId();
501 repoClass = repository.getClass();
502 } else {
503 repoId = null;
504 repoClass = null;
505 }
506 }
507 }
508 }