1 package org.apache.archiva.scheduler.indexing;
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements. See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership. The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License. You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied. See the License for the
17 * specific language governing permissions and limitations
21 import org.apache.archiva.admin.model.RepositoryAdminException;
22 import org.apache.archiva.admin.model.beans.NetworkProxy;
23 import org.apache.archiva.admin.model.beans.RemoteRepository;
24 import org.apache.archiva.admin.model.remote.RemoteRepositoryAdmin;
25 import org.apache.archiva.proxy.common.WagonFactory;
26 import org.apache.archiva.proxy.common.WagonFactoryException;
27 import org.apache.archiva.proxy.common.WagonFactoryRequest;
28 import org.apache.commons.io.FileUtils;
29 import org.apache.commons.lang.time.StopWatch;
30 import org.apache.maven.index.context.IndexingContext;
31 import org.apache.maven.index.updater.IndexUpdateRequest;
32 import org.apache.maven.index.updater.IndexUpdater;
33 import org.apache.maven.index.updater.ResourceFetcher;
34 import org.apache.maven.wagon.ConnectionException;
35 import org.apache.maven.wagon.ResourceDoesNotExistException;
36 import org.apache.maven.wagon.StreamWagon;
37 import org.apache.maven.wagon.TransferFailedException;
38 import org.apache.maven.wagon.Wagon;
39 import org.apache.maven.wagon.authentication.AuthenticationException;
40 import org.apache.maven.wagon.authentication.AuthenticationInfo;
41 import org.apache.maven.wagon.authorization.AuthorizationException;
42 import org.apache.maven.wagon.events.TransferEvent;
43 import org.apache.maven.wagon.events.TransferListener;
44 import org.apache.maven.wagon.providers.http.AbstractHttpClientWagon;
45 import org.apache.maven.wagon.providers.http.HttpConfiguration;
46 import org.apache.maven.wagon.providers.http.HttpMethodConfiguration;
47 import org.apache.maven.wagon.proxy.ProxyInfo;
48 import org.apache.maven.wagon.repository.Repository;
49 import org.slf4j.Logger;
50 import org.slf4j.LoggerFactory;
53 import java.io.FileNotFoundException;
54 import java.io.IOException;
55 import java.io.InputStream;
56 import java.net.MalformedURLException;
58 import java.nio.file.Files;
59 import java.util.List;
63 * @author Olivier Lamy
66 public class DownloadRemoteIndexTask
69 private Logger log = LoggerFactory.getLogger( getClass() );
71 private RemoteRepository remoteRepository;
73 private RemoteRepositoryAdmin remoteRepositoryAdmin;
75 private WagonFactory wagonFactory;
77 private NetworkProxy networkProxy;
79 private boolean fullDownload;
81 private List<String> runningRemoteDownloadIds;
83 private IndexUpdater indexUpdater;
86 public DownloadRemoteIndexTask( DownloadRemoteIndexTaskRequest downloadRemoteIndexTaskRequest,
87 List<String> runningRemoteDownloadIds )
89 this.remoteRepository = downloadRemoteIndexTaskRequest.getRemoteRepository();
90 this.wagonFactory = downloadRemoteIndexTaskRequest.getWagonFactory();
91 this.networkProxy = downloadRemoteIndexTaskRequest.getNetworkProxy();
92 this.fullDownload = downloadRemoteIndexTaskRequest.isFullDownload();
93 this.runningRemoteDownloadIds = runningRemoteDownloadIds;
94 this.indexUpdater = downloadRemoteIndexTaskRequest.getIndexUpdater();
95 this.remoteRepositoryAdmin = downloadRemoteIndexTaskRequest.getRemoteRepositoryAdmin();
102 // so short lock : not sure we need it
103 synchronized ( this.runningRemoteDownloadIds )
105 if ( this.runningRemoteDownloadIds.contains( this.remoteRepository.getId() ) )
107 // skip it as it's running
108 log.info( "skip download index remote for repo {} it's already running",
109 this.remoteRepository.getId() );
112 this.runningRemoteDownloadIds.add( this.remoteRepository.getId() );
114 File tempIndexDirectory = null;
115 StopWatch stopWatch = new StopWatch();
119 log.info( "start download remote index for remote repository {}", this.remoteRepository.getId() );
120 IndexingContext indexingContext = remoteRepositoryAdmin.createIndexContext( this.remoteRepository );
122 // create a temp directory to download files
123 tempIndexDirectory = new File( indexingContext.getIndexDirectoryFile().getParent(), ".tmpIndex" );
124 File indexCacheDirectory = new File( indexingContext.getIndexDirectoryFile().getParent(), ".indexCache" );
125 indexCacheDirectory.mkdirs();
126 if ( tempIndexDirectory.exists() )
128 FileUtils.deleteDirectory( tempIndexDirectory );
130 tempIndexDirectory.mkdirs();
131 tempIndexDirectory.deleteOnExit();
132 String baseIndexUrl = indexingContext.getIndexUpdateUrl();
134 String wagonProtocol = new URL( this.remoteRepository.getUrl() ).getProtocol();
136 final StreamWagon wagon = (StreamWagon) wagonFactory.getWagon(
137 new WagonFactoryRequest( wagonProtocol, this.remoteRepository.getExtraHeaders() ).networkProxy(
140 // FIXME olamy having 2 config values
141 wagon.setReadTimeout( remoteRepository.getRemoteDownloadTimeout() * 1000 );
142 wagon.setTimeout( remoteRepository.getTimeout() * 1000 );
144 if ( wagon instanceof AbstractHttpClientWagon )
146 HttpConfiguration httpConfiguration = new HttpConfiguration();
147 HttpMethodConfiguration httpMethodConfiguration = new HttpMethodConfiguration();
148 httpMethodConfiguration.setUsePreemptive( true );
149 httpMethodConfiguration.setReadTimeout( remoteRepository.getRemoteDownloadTimeout() * 1000 );
150 httpConfiguration.setGet( httpMethodConfiguration );
151 AbstractHttpClientWagon.class.cast( wagon ).setHttpConfiguration( httpConfiguration );
154 wagon.addTransferListener( new DownloadListener() );
155 ProxyInfo proxyInfo = null;
156 if ( this.networkProxy != null )
158 proxyInfo = new ProxyInfo();
159 proxyInfo.setType( this.networkProxy.getProtocol() );
160 proxyInfo.setHost( this.networkProxy.getHost() );
161 proxyInfo.setPort( this.networkProxy.getPort() );
162 proxyInfo.setUserName( this.networkProxy.getUsername() );
163 proxyInfo.setPassword( this.networkProxy.getPassword() );
165 AuthenticationInfo authenticationInfo = null;
166 if ( this.remoteRepository.getUserName() != null )
168 authenticationInfo = new AuthenticationInfo();
169 authenticationInfo.setUserName( this.remoteRepository.getUserName() );
170 authenticationInfo.setPassword( this.remoteRepository.getPassword() );
172 wagon.connect( new Repository( this.remoteRepository.getId(), baseIndexUrl ), authenticationInfo,
175 File indexDirectory = indexingContext.getIndexDirectoryFile();
176 if ( !indexDirectory.exists() )
178 indexDirectory.mkdirs();
181 ResourceFetcher resourceFetcher =
182 new WagonResourceFetcher( log, tempIndexDirectory, wagon, remoteRepository );
183 IndexUpdateRequest request = new IndexUpdateRequest( indexingContext, resourceFetcher );
184 request.setForceFullUpdate( this.fullDownload );
185 request.setLocalIndexCacheDir( indexCacheDirectory );
187 this.indexUpdater.fetchAndUpdateIndex( request );
189 log.info( "time update index from remote for repository {}: {} s", this.remoteRepository.getId(),
190 ( stopWatch.getTime() / 1000 ) );
192 // index packing optionnal ??
193 //IndexPackingRequest indexPackingRequest =
194 // new IndexPackingRequest( indexingContext, indexingContext.getIndexDirectoryFile() );
195 //indexPacker.packIndex( indexPackingRequest );
196 indexingContext.updateTimestamp( true );
199 catch ( Exception e )
201 log.error( e.getMessage(), e );
202 throw new RuntimeException( e.getMessage(), e );
206 deleteDirectoryQuiet( tempIndexDirectory );
207 this.runningRemoteDownloadIds.remove( this.remoteRepository.getId() );
209 log.info( "end download remote index for remote repository {}", this.remoteRepository.getId() );
212 private void deleteDirectoryQuiet( File f )
216 FileUtils.deleteDirectory( f );
218 catch ( IOException e )
220 log.warn( "skip error delete {} : {}", f, e.getMessage() );
225 private static final class DownloadListener
226 implements TransferListener
228 private Logger log = LoggerFactory.getLogger( getClass() );
230 private String resourceName;
232 private long startTime;
234 private int totalLength = 0;
237 public void transferInitiated( TransferEvent transferEvent )
239 startTime = System.currentTimeMillis();
240 resourceName = transferEvent.getResource().getName();
241 log.debug( "initiate transfer of {}", resourceName );
245 public void transferStarted( TransferEvent transferEvent )
247 this.totalLength = 0;
248 resourceName = transferEvent.getResource().getName();
249 log.info( "start transfer of {}", transferEvent.getResource().getName() );
253 public void transferProgress( TransferEvent transferEvent, byte[] buffer, int length )
255 log.debug( "transfer of {} : {}/{}", transferEvent.getResource().getName(), buffer.length, length );
256 this.totalLength += length;
260 public void transferCompleted( TransferEvent transferEvent )
262 resourceName = transferEvent.getResource().getName();
263 long endTime = System.currentTimeMillis();
264 log.info( "end of transfer file {} {} kb: {}s", transferEvent.getResource().getName(),
265 this.totalLength / 1024, ( endTime - startTime ) / 1000 );
269 public void transferError( TransferEvent transferEvent )
271 log.info( "error of transfer file {}: {}", transferEvent.getResource().getName(),
272 transferEvent.getException().getMessage(), transferEvent.getException() );
276 public void debug( String message )
278 log.debug( "transfer debug {}", message );
282 private static class WagonResourceFetcher
283 implements ResourceFetcher
288 File tempIndexDirectory;
292 RemoteRepository remoteRepository;
294 private WagonResourceFetcher( Logger log, File tempIndexDirectory, Wagon wagon,
295 RemoteRepository remoteRepository )
298 this.tempIndexDirectory = tempIndexDirectory;
300 this.remoteRepository = remoteRepository;
304 public void connect( String id, String url )
311 public void disconnect()
318 public InputStream retrieve( String name )
319 throws IOException, FileNotFoundException
323 log.info( "index update retrieve file, name:{}", name );
324 File file = new File( tempIndexDirectory, name );
325 Files.deleteIfExists( file.toPath() );
327 wagon.get( addParameters( name, this.remoteRepository ), file );
328 return Files.newInputStream( file.toPath() );
330 catch ( AuthorizationException | TransferFailedException e )
332 throw new IOException( e.getMessage(), e );
334 catch ( ResourceDoesNotExistException e )
336 FileNotFoundException fnfe = new FileNotFoundException( e.getMessage() );
342 // FIXME remove crappy copy/paste
343 protected String addParameters( String path, RemoteRepository remoteRepository )
345 if ( remoteRepository.getExtraParameters().isEmpty() )
350 boolean question = false;
352 StringBuilder res = new StringBuilder( path == null ? "" : path );
354 for ( Map.Entry<String, String> entry : remoteRepository.getExtraParameters().entrySet() )
358 res.append( '?' ).append( entry.getKey() ).append( '=' ).append( entry.getValue() );
362 return res.toString();