1 package org.eclipse.aether.internal.impl;
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22 import java.io.File;
23 import java.util.ArrayList;
24 import java.util.Arrays;
25 import java.util.Collection;
26 import java.util.Collections;
27 import java.util.HashMap;
28 import java.util.List;
29 import java.util.Map;
30 import static java.util.Objects.requireNonNull;
31 import java.util.concurrent.Executor;
32 import java.util.concurrent.ExecutorService;
33 import java.util.concurrent.LinkedBlockingQueue;
34 import java.util.concurrent.ThreadPoolExecutor;
35 import java.util.concurrent.TimeUnit;
36
37 import javax.inject.Inject;
38 import javax.inject.Named;
39
40 import org.eclipse.aether.RepositoryEvent;
41 import org.eclipse.aether.RepositoryEvent.EventType;
42 import org.eclipse.aether.RepositorySystemSession;
43 import org.eclipse.aether.RequestTrace;
44 import org.eclipse.aether.SyncContext;
45 import org.eclipse.aether.impl.MetadataResolver;
46 import org.eclipse.aether.impl.OfflineController;
47 import org.eclipse.aether.impl.RemoteRepositoryManager;
48 import org.eclipse.aether.impl.RepositoryConnectorProvider;
49 import org.eclipse.aether.impl.RepositoryEventDispatcher;
50 import org.eclipse.aether.impl.SyncContextFactory;
51 import org.eclipse.aether.impl.UpdateCheck;
52 import org.eclipse.aether.impl.UpdateCheckManager;
53 import org.eclipse.aether.metadata.Metadata;
54 import org.eclipse.aether.repository.ArtifactRepository;
55 import org.eclipse.aether.repository.LocalMetadataRegistration;
56 import org.eclipse.aether.repository.LocalMetadataRequest;
57 import org.eclipse.aether.repository.LocalMetadataResult;
58 import org.eclipse.aether.repository.LocalRepository;
59 import org.eclipse.aether.repository.LocalRepositoryManager;
60 import org.eclipse.aether.repository.RemoteRepository;
61 import org.eclipse.aether.repository.RepositoryPolicy;
62 import org.eclipse.aether.resolution.MetadataRequest;
63 import org.eclipse.aether.resolution.MetadataResult;
64 import org.eclipse.aether.spi.connector.MetadataDownload;
65 import org.eclipse.aether.spi.connector.RepositoryConnector;
66 import org.eclipse.aether.spi.locator.Service;
67 import org.eclipse.aether.spi.locator.ServiceLocator;
68 import org.eclipse.aether.transfer.MetadataNotFoundException;
69 import org.eclipse.aether.transfer.MetadataTransferException;
70 import org.eclipse.aether.transfer.NoRepositoryConnectorException;
71 import org.eclipse.aether.transfer.RepositoryOfflineException;
72 import org.eclipse.aether.util.ConfigUtils;
73 import org.eclipse.aether.util.concurrency.RunnableErrorForwarder;
74 import org.eclipse.aether.util.concurrency.WorkerThreadFactory;
75
76
77
78 @Named
79 public class DefaultMetadataResolver
80 implements MetadataResolver, Service
81 {
82
83 private static final String CONFIG_PROP_THREADS = "aether.metadataResolver.threads";
84
85 private RepositoryEventDispatcher repositoryEventDispatcher;
86
87 private UpdateCheckManager updateCheckManager;
88
89 private RepositoryConnectorProvider repositoryConnectorProvider;
90
91 private RemoteRepositoryManager remoteRepositoryManager;
92
93 private SyncContextFactory syncContextFactory;
94
95 private OfflineController offlineController;
96
97 public DefaultMetadataResolver()
98 {
99
100 }
101
102 @Inject
103 DefaultMetadataResolver( RepositoryEventDispatcher repositoryEventDispatcher,
104 UpdateCheckManager updateCheckManager,
105 RepositoryConnectorProvider repositoryConnectorProvider,
106 RemoteRepositoryManager remoteRepositoryManager, SyncContextFactory syncContextFactory,
107 OfflineController offlineController )
108 {
109 setRepositoryEventDispatcher( repositoryEventDispatcher );
110 setUpdateCheckManager( updateCheckManager );
111 setRepositoryConnectorProvider( repositoryConnectorProvider );
112 setRemoteRepositoryManager( remoteRepositoryManager );
113 setSyncContextFactory( syncContextFactory );
114 setOfflineController( offlineController );
115 }
116
117 public void initService( ServiceLocator locator )
118 {
119 setRepositoryEventDispatcher( locator.getService( RepositoryEventDispatcher.class ) );
120 setUpdateCheckManager( locator.getService( UpdateCheckManager.class ) );
121 setRepositoryConnectorProvider( locator.getService( RepositoryConnectorProvider.class ) );
122 setRemoteRepositoryManager( locator.getService( RemoteRepositoryManager.class ) );
123 setSyncContextFactory( locator.getService( SyncContextFactory.class ) );
124 setOfflineController( locator.getService( OfflineController.class ) );
125 }
126
127 public DefaultMetadataResolver setRepositoryEventDispatcher( RepositoryEventDispatcher repositoryEventDispatcher )
128 {
129 this.repositoryEventDispatcher = requireNonNull(
130 repositoryEventDispatcher, "repository event dispatcher cannot be null" );
131 return this;
132 }
133
134 public DefaultMetadataResolver setUpdateCheckManager( UpdateCheckManager updateCheckManager )
135 {
136 this.updateCheckManager = requireNonNull( updateCheckManager, "update check manager cannot be null" );
137 return this;
138 }
139
140 public DefaultMetadataResolver setRepositoryConnectorProvider(
141 RepositoryConnectorProvider repositoryConnectorProvider )
142 {
143 this.repositoryConnectorProvider = requireNonNull(
144 repositoryConnectorProvider, "repository connector provider cannot be null" );
145 return this;
146 }
147
148 public DefaultMetadataResolver setRemoteRepositoryManager( RemoteRepositoryManager remoteRepositoryManager )
149 {
150 this.remoteRepositoryManager = requireNonNull(
151 remoteRepositoryManager, "remote repository provider cannot be null" );
152 return this;
153 }
154
155 public DefaultMetadataResolver setSyncContextFactory( SyncContextFactory syncContextFactory )
156 {
157 this.syncContextFactory = requireNonNull( syncContextFactory, "sync context factory cannot be null" );
158 return this;
159 }
160
161 public DefaultMetadataResolver setOfflineController( OfflineController offlineController )
162 {
163 this.offlineController = requireNonNull( offlineController, "offline controller cannot be null" );
164 return this;
165 }
166
167 public List<MetadataResult> resolveMetadata( RepositorySystemSession session,
168 Collection<? extends MetadataRequest> requests )
169 {
170
171 try ( SyncContext syncContext = syncContextFactory.newInstance( session, false ) )
172 {
173 Collection<Metadata> metadata = new ArrayList<>( requests.size() );
174 for ( MetadataRequest request : requests )
175 {
176 metadata.add( request.getMetadata() );
177 }
178
179 syncContext.acquire( null, metadata );
180
181 return resolve( session, requests );
182 }
183 }
184
185 @SuppressWarnings( "checkstyle:methodlength" )
186 private List<MetadataResult> resolve( RepositorySystemSession session,
187 Collection<? extends MetadataRequest> requests )
188 {
189 List<MetadataResult> results = new ArrayList<>( requests.size() );
190
191 List<ResolveTask> tasks = new ArrayList<>( requests.size() );
192
193 Map<File, Long> localLastUpdates = new HashMap<>();
194
195 for ( MetadataRequest request : requests )
196 {
197 RequestTrace trace = RequestTrace.newChild( request.getTrace(), request );
198
199 MetadataResult result = new MetadataResult( request );
200 results.add( result );
201
202 Metadata metadata = request.getMetadata();
203 RemoteRepository repository = request.getRepository();
204
205 if ( repository == null )
206 {
207 LocalRepository localRepo = session.getLocalRepositoryManager().getRepository();
208
209 metadataResolving( session, trace, metadata, localRepo );
210
211 File localFile = getLocalFile( session, metadata );
212
213 if ( localFile != null )
214 {
215 metadata = metadata.setFile( localFile );
216 result.setMetadata( metadata );
217 }
218 else
219 {
220 result.setException( new MetadataNotFoundException( metadata, localRepo ) );
221 }
222
223 metadataResolved( session, trace, metadata, localRepo, result.getException() );
224 continue;
225 }
226
227 List<RemoteRepository> repositories = getEnabledSourceRepositories( repository, metadata.getNature() );
228
229 if ( repositories.isEmpty() )
230 {
231 continue;
232 }
233
234 metadataResolving( session, trace, metadata, repository );
235 LocalRepositoryManager lrm = session.getLocalRepositoryManager();
236 LocalMetadataRequest localRequest =
237 new LocalMetadataRequest( metadata, repository, request.getRequestContext() );
238 LocalMetadataResult lrmResult = lrm.find( session, localRequest );
239
240 File metadataFile = lrmResult.getFile();
241
242 try
243 {
244 Utils.checkOffline( session, offlineController, repository );
245 }
246 catch ( RepositoryOfflineException e )
247 {
248 if ( metadataFile != null )
249 {
250 metadata = metadata.setFile( metadataFile );
251 result.setMetadata( metadata );
252 }
253 else
254 {
255 String msg =
256 "Cannot access " + repository.getId() + " (" + repository.getUrl()
257 + ") in offline mode and the metadata " + metadata
258 + " has not been downloaded from it before";
259 result.setException( new MetadataNotFoundException( metadata, repository, msg, e ) );
260 }
261
262 metadataResolved( session, trace, metadata, repository, result.getException() );
263 continue;
264 }
265
266 Long localLastUpdate = null;
267 if ( request.isFavorLocalRepository() )
268 {
269 File localFile = getLocalFile( session, metadata );
270 localLastUpdate = localLastUpdates.get( localFile );
271 if ( localLastUpdate == null )
272 {
273 localLastUpdate = localFile != null ? localFile.lastModified() : 0;
274 localLastUpdates.put( localFile, localLastUpdate );
275 }
276 }
277
278 List<UpdateCheck<Metadata, MetadataTransferException>> checks = new ArrayList<>();
279 Exception exception = null;
280 for ( RemoteRepository repo : repositories )
281 {
282 UpdateCheck<Metadata, MetadataTransferException> check = new UpdateCheck<>();
283 check.setLocalLastUpdated( ( localLastUpdate != null ) ? localLastUpdate : 0 );
284 check.setItem( metadata );
285
286
287 File checkFile = new File(
288 session.getLocalRepository().getBasedir(),
289 session.getLocalRepositoryManager()
290 .getPathForRemoteMetadata( metadata, repository, request.getRequestContext() ) );
291 check.setFile( checkFile );
292 check.setRepository( repository );
293 check.setAuthoritativeRepository( repo );
294 check.setPolicy( getPolicy( session, repo, metadata.getNature() ).getUpdatePolicy() );
295
296 if ( lrmResult.isStale() )
297 {
298 checks.add( check );
299 }
300 else
301 {
302 updateCheckManager.checkMetadata( session, check );
303 if ( check.isRequired() )
304 {
305 checks.add( check );
306 }
307 else if ( exception == null )
308 {
309 exception = check.getException();
310 }
311 }
312 }
313
314 if ( !checks.isEmpty() )
315 {
316 RepositoryPolicy policy = getPolicy( session, repository, metadata.getNature() );
317
318
319 File installFile = new File(
320 session.getLocalRepository().getBasedir(),
321 session.getLocalRepositoryManager().getPathForRemoteMetadata(
322 metadata, request.getRepository(), request.getRequestContext() ) );
323
324 metadataDownloading(
325 session, trace, result.getRequest().getMetadata(), result.getRequest().getRepository() );
326
327 ResolveTask task =
328 new ResolveTask( session, trace, result, installFile, checks, policy.getChecksumPolicy() );
329 tasks.add( task );
330 }
331 else
332 {
333 result.setException( exception );
334 if ( metadataFile != null )
335 {
336 metadata = metadata.setFile( metadataFile );
337 result.setMetadata( metadata );
338 }
339 metadataResolved( session, trace, metadata, repository, result.getException() );
340 }
341 }
342
343 if ( !tasks.isEmpty() )
344 {
345 int threads = ConfigUtils.getInteger( session, 4, CONFIG_PROP_THREADS );
346 Executor executor = getExecutor( Math.min( tasks.size(), threads ) );
347 try
348 {
349 RunnableErrorForwarder errorForwarder = new RunnableErrorForwarder();
350
351 for ( ResolveTask task : tasks )
352 {
353 executor.execute( errorForwarder.wrap( task ) );
354 }
355
356 errorForwarder.await();
357
358 for ( ResolveTask task : tasks )
359 {
360
361
362
363
364
365 for ( UpdateCheck<Metadata, MetadataTransferException> check : task.checks )
366 {
367 updateCheckManager.touchMetadata( task.session, check.setException( task.exception ) );
368 }
369
370 metadataDownloaded( session, task.trace, task.request.getMetadata(), task.request.getRepository(),
371 task.metadataFile, task.exception );
372
373 task.result.setException( task.exception );
374 }
375 }
376 finally
377 {
378 shutdown( executor );
379 }
380 for ( ResolveTask task : tasks )
381 {
382 Metadata metadata = task.request.getMetadata();
383
384 LocalMetadataRequest localRequest = new LocalMetadataRequest(
385 metadata, task.request.getRepository(), task.request.getRequestContext() );
386 File metadataFile = session.getLocalRepositoryManager().find( session, localRequest ).getFile();
387 if ( metadataFile != null )
388 {
389 metadata = metadata.setFile( metadataFile );
390 task.result.setMetadata( metadata );
391 }
392 if ( task.result.getException() == null )
393 {
394 task.result.setUpdated( true );
395 }
396 metadataResolved( session, task.trace, metadata, task.request.getRepository(),
397 task.result.getException() );
398 }
399 }
400
401 return results;
402 }
403
404 private File getLocalFile( RepositorySystemSession session, Metadata metadata )
405 {
406 LocalRepositoryManager lrm = session.getLocalRepositoryManager();
407 LocalMetadataResult localResult = lrm.find( session, new LocalMetadataRequest( metadata, null, null ) );
408 return localResult.getFile();
409 }
410
411 private List<RemoteRepository> getEnabledSourceRepositories( RemoteRepository repository, Metadata.Nature nature )
412 {
413 List<RemoteRepository> repositories = new ArrayList<>();
414
415 if ( repository.isRepositoryManager() )
416 {
417 for ( RemoteRepository repo : repository.getMirroredRepositories() )
418 {
419 if ( isEnabled( repo, nature ) )
420 {
421 repositories.add( repo );
422 }
423 }
424 }
425 else if ( isEnabled( repository, nature ) )
426 {
427 repositories.add( repository );
428 }
429
430 return repositories;
431 }
432
433 private boolean isEnabled( RemoteRepository repository, Metadata.Nature nature )
434 {
435 if ( !Metadata.Nature.SNAPSHOT.equals( nature ) && repository.getPolicy( false ).isEnabled() )
436 {
437 return true;
438 }
439 if ( !Metadata.Nature.RELEASE.equals( nature ) && repository.getPolicy( true ).isEnabled() )
440 {
441 return true;
442 }
443 return false;
444 }
445
446 private RepositoryPolicy getPolicy( RepositorySystemSession session, RemoteRepository repository,
447 Metadata.Nature nature )
448 {
449 boolean releases = !Metadata.Nature.SNAPSHOT.equals( nature );
450 boolean snapshots = !Metadata.Nature.RELEASE.equals( nature );
451 return remoteRepositoryManager.getPolicy( session, repository, releases, snapshots );
452 }
453
454 private void metadataResolving( RepositorySystemSession session, RequestTrace trace, Metadata metadata,
455 ArtifactRepository repository )
456 {
457 RepositoryEvent.Builder event = new RepositoryEvent.Builder( session, EventType.METADATA_RESOLVING );
458 event.setTrace( trace );
459 event.setMetadata( metadata );
460 event.setRepository( repository );
461
462 repositoryEventDispatcher.dispatch( event.build() );
463 }
464
465 private void metadataResolved( RepositorySystemSession session, RequestTrace trace, Metadata metadata,
466 ArtifactRepository repository, Exception exception )
467 {
468 RepositoryEvent.Builder event = new RepositoryEvent.Builder( session, EventType.METADATA_RESOLVED );
469 event.setTrace( trace );
470 event.setMetadata( metadata );
471 event.setRepository( repository );
472 event.setException( exception );
473 event.setFile( metadata.getFile() );
474
475 repositoryEventDispatcher.dispatch( event.build() );
476 }
477
478 private void metadataDownloading( RepositorySystemSession session, RequestTrace trace, Metadata metadata,
479 ArtifactRepository repository )
480 {
481 RepositoryEvent.Builder event = new RepositoryEvent.Builder( session, EventType.METADATA_DOWNLOADING );
482 event.setTrace( trace );
483 event.setMetadata( metadata );
484 event.setRepository( repository );
485
486 repositoryEventDispatcher.dispatch( event.build() );
487 }
488
489 private void metadataDownloaded( RepositorySystemSession session, RequestTrace trace, Metadata metadata,
490 ArtifactRepository repository, File file, Exception exception )
491 {
492 RepositoryEvent.Builder event = new RepositoryEvent.Builder( session, EventType.METADATA_DOWNLOADED );
493 event.setTrace( trace );
494 event.setMetadata( metadata );
495 event.setRepository( repository );
496 event.setException( exception );
497 event.setFile( file );
498
499 repositoryEventDispatcher.dispatch( event.build() );
500 }
501
502 private Executor getExecutor( int threads )
503 {
504 if ( threads <= 1 )
505 {
506 return new Executor()
507 {
508 public void execute( Runnable command )
509 {
510 command.run();
511 }
512 };
513 }
514 else
515 {
516 return new ThreadPoolExecutor( threads, threads, 3, TimeUnit.SECONDS, new LinkedBlockingQueue<Runnable>(),
517 new WorkerThreadFactory( null ) );
518 }
519 }
520
521 private void shutdown( Executor executor )
522 {
523 if ( executor instanceof ExecutorService )
524 {
525 ( (ExecutorService) executor ).shutdown();
526 }
527 }
528
529 class ResolveTask
530 implements Runnable
531 {
532 final RepositorySystemSession session;
533
534 final RequestTrace trace;
535
536 final MetadataResult result;
537
538 final MetadataRequest request;
539
540 final File metadataFile;
541
542 final String policy;
543
544 final List<UpdateCheck<Metadata, MetadataTransferException>> checks;
545
546 volatile MetadataTransferException exception;
547
548 ResolveTask( RepositorySystemSession session, RequestTrace trace, MetadataResult result,
549 File metadataFile, List<UpdateCheck<Metadata, MetadataTransferException>> checks,
550 String policy )
551 {
552 this.session = session;
553 this.trace = trace;
554 this.result = result;
555 this.request = result.getRequest();
556 this.metadataFile = metadataFile;
557 this.policy = policy;
558 this.checks = checks;
559 }
560
561 public void run()
562 {
563 Metadata metadata = request.getMetadata();
564 RemoteRepository requestRepository = request.getRepository();
565
566 try
567 {
568 List<RemoteRepository> repositories = new ArrayList<>();
569 for ( UpdateCheck<Metadata, MetadataTransferException> check : checks )
570 {
571 repositories.add( check.getAuthoritativeRepository() );
572 }
573
574 MetadataDownload download = new MetadataDownload();
575 download.setMetadata( metadata );
576 download.setRequestContext( request.getRequestContext() );
577 download.setFile( metadataFile );
578 download.setChecksumPolicy( policy );
579 download.setRepositories( repositories );
580 download.setListener( SafeTransferListener.wrap( session ) );
581 download.setTrace( trace );
582
583 try ( RepositoryConnector connector =
584 repositoryConnectorProvider.newRepositoryConnector( session, requestRepository ) )
585 {
586 connector.get( null, Arrays.asList( download ) );
587 }
588
589 exception = download.getException();
590
591 if ( exception == null )
592 {
593
594 List<String> contexts = Collections.singletonList( request.getRequestContext() );
595 LocalMetadataRegistration registration =
596 new LocalMetadataRegistration( metadata, requestRepository, contexts );
597
598 session.getLocalRepositoryManager().add( session, registration );
599 }
600 else if ( request.isDeleteLocalCopyIfMissing() && exception instanceof MetadataNotFoundException )
601 {
602 download.getFile().delete();
603 }
604 }
605 catch ( NoRepositoryConnectorException e )
606 {
607 exception = new MetadataTransferException( metadata, requestRepository, e );
608 }
609 }
610 }
611 }