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.packer.IndexPacker;
32 import org.apache.maven.index.packer.IndexPackingRequest;
33 import org.apache.maven.index.updater.IndexUpdateRequest;
34 import org.apache.maven.index.updater.IndexUpdater;
35 import org.apache.maven.index.updater.ResourceFetcher;
36 import org.apache.maven.wagon.ConnectionException;
37 import org.apache.maven.wagon.ResourceDoesNotExistException;
38 import org.apache.maven.wagon.StreamWagon;
39 import org.apache.maven.wagon.TransferFailedException;
40 import org.apache.maven.wagon.Wagon;
41 import org.apache.maven.wagon.authentication.AuthenticationException;
42 import org.apache.maven.wagon.authentication.AuthenticationInfo;
43 import org.apache.maven.wagon.authorization.AuthorizationException;
44 import org.apache.maven.wagon.events.TransferEvent;
45 import org.apache.maven.wagon.events.TransferListener;
46 import org.apache.maven.wagon.proxy.ProxyInfo;
47 import org.apache.maven.wagon.repository.Repository;
48 import org.slf4j.Logger;
49 import org.slf4j.LoggerFactory;
52 import java.io.FileInputStream;
53 import java.io.FileNotFoundException;
54 import java.io.IOException;
55 import java.io.InputStream;
56 import java.net.MalformedURLException;
58 import java.util.Arrays;
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;
85 private IndexPacker indexPacker;
87 public DownloadRemoteIndexTask( DownloadRemoteIndexTaskRequest downloadRemoteIndexTaskRequest,
88 List<String> runningRemoteDownloadIds )
90 this.remoteRepository = downloadRemoteIndexTaskRequest.getRemoteRepository();
91 this.wagonFactory = downloadRemoteIndexTaskRequest.getWagonFactory();
92 this.networkProxy = downloadRemoteIndexTaskRequest.getNetworkProxy();
93 this.fullDownload = downloadRemoteIndexTaskRequest.isFullDownload();
94 this.runningRemoteDownloadIds = runningRemoteDownloadIds;
95 this.indexUpdater = downloadRemoteIndexTaskRequest.getIndexUpdater();
96 this.remoteRepositoryAdmin = downloadRemoteIndexTaskRequest.getRemoteRepositoryAdmin();
97 this.indexPacker = downloadRemoteIndexTaskRequest.getIndexPacker();
103 // so short lock : not sure we need it
104 synchronized ( this.runningRemoteDownloadIds )
106 if ( this.runningRemoteDownloadIds.contains( this.remoteRepository.getId() ) )
108 // skip it as it's running
109 log.info( "skip download index remote for repo {} it's already running",
110 this.remoteRepository.getId() );
113 this.runningRemoteDownloadIds.add( this.remoteRepository.getId() );
115 File tempIndexDirectory = null;
116 StopWatch stopWatch = new StopWatch();
120 log.info( "start download remote index for remote repository {}", this.remoteRepository.getId() );
121 IndexingContext indexingContext = remoteRepositoryAdmin.createIndexContext( this.remoteRepository );
123 // create a temp directory to download files
124 tempIndexDirectory = new File( indexingContext.getIndexDirectoryFile().getParent(), ".tmpIndex" );
125 File indexCacheDirectory = new File( indexingContext.getIndexDirectoryFile().getParent(), ".indexCache" );
126 indexCacheDirectory.mkdirs();
127 if ( tempIndexDirectory.exists() )
129 FileUtils.deleteDirectory( tempIndexDirectory );
131 tempIndexDirectory.mkdirs();
132 tempIndexDirectory.deleteOnExit();
133 String baseIndexUrl = indexingContext.getIndexUpdateUrl();
135 String wagonProtocol =
136 new URL( this.remoteRepository.getUrl() ).getProtocol() + ( ( this.networkProxy != null
137 && this.networkProxy.isUseNtlm() ) ? "-ntlm" : "" );
139 final StreamWagon wagon = (StreamWagon) wagonFactory.getWagon(
140 new WagonFactoryRequest( wagonProtocol, this.remoteRepository.getExtraHeaders() ) );
141 int timeoutInMilliseconds = remoteRepository.getTimeout() * 1000;
142 // FIXME olamy having 2 config values
143 wagon.setReadTimeout( timeoutInMilliseconds );
144 wagon.setTimeout( timeoutInMilliseconds );
146 wagon.addTransferListener( new DownloadListener() );
147 ProxyInfo proxyInfo = null;
148 if ( this.networkProxy != null )
150 proxyInfo = new ProxyInfo();
151 proxyInfo.setHost( this.networkProxy.getHost() );
152 proxyInfo.setPort( this.networkProxy.getPort() );
153 proxyInfo.setUserName( this.networkProxy.getUsername() );
154 proxyInfo.setPassword( this.networkProxy.getPassword() );
156 AuthenticationInfo authenticationInfo = null;
157 if ( this.remoteRepository.getUserName() != null )
159 authenticationInfo = new AuthenticationInfo();
160 authenticationInfo.setUserName( this.remoteRepository.getUserName() );
161 authenticationInfo.setPassword( this.remoteRepository.getPassword() );
163 wagon.connect( new Repository( this.remoteRepository.getId(), baseIndexUrl ), authenticationInfo,
166 File indexDirectory = indexingContext.getIndexDirectoryFile();
167 if ( !indexDirectory.exists() )
169 indexDirectory.mkdirs();
172 ResourceFetcher resourceFetcher =
173 new WagonResourceFetcher( log, tempIndexDirectory, wagon, remoteRepository );
174 IndexUpdateRequest request = new IndexUpdateRequest( indexingContext, resourceFetcher );
175 request.setForceFullUpdate( this.fullDownload );
176 request.setLocalIndexCacheDir( indexCacheDirectory );
178 this.indexUpdater.fetchAndUpdateIndex( request );
180 log.info( "time to download remote repository index for repository {}: {} s", this.remoteRepository.getId(),
181 ( stopWatch.getTime() / 1000 ) );
183 // index packing optionnal ??
184 IndexPackingRequest indexPackingRequest =
185 new IndexPackingRequest( indexingContext, indexingContext.getIndexDirectoryFile() );
186 indexPacker.packIndex( indexPackingRequest );
187 indexingContext.updateTimestamp( true );
190 catch ( MalformedURLException e )
192 log.error( e.getMessage(), e );
193 throw new RuntimeException( e.getMessage(), e );
195 catch ( WagonFactoryException e )
197 log.error( e.getMessage(), e );
198 throw new RuntimeException( e.getMessage(), e );
200 catch ( ConnectionException e )
202 log.error( e.getMessage(), e );
203 throw new RuntimeException( e.getMessage(), e );
205 catch ( AuthenticationException e )
207 log.error( e.getMessage(), e );
208 throw new RuntimeException( e.getMessage(), e );
210 catch ( IOException e )
212 log.error( e.getMessage(), e );
213 throw new RuntimeException( e.getMessage(), e );
215 catch ( RepositoryAdminException e )
217 log.error( e.getMessage(), e );
218 throw new RuntimeException( e.getMessage(), e );
222 deleteDirectoryQuiet( tempIndexDirectory );
223 this.runningRemoteDownloadIds.remove( this.remoteRepository.getId() );
225 log.info( "end download remote index for remote repository " + this.remoteRepository.getId() );
228 private void deleteDirectoryQuiet( File f )
232 FileUtils.deleteDirectory( f );
234 catch ( IOException e )
236 log.warn( "skip error delete {} : {}", f, e.getMessage() );
241 public static class DownloadListener
242 implements TransferListener
244 private Logger log = LoggerFactory.getLogger( getClass() );
250 public void transferInitiated( TransferEvent transferEvent )
252 resourceName = transferEvent.getResource().getName();
253 log.debug( "initiate transfer of {}", resourceName );
256 public void transferStarted( TransferEvent transferEvent )
258 resourceName = transferEvent.getResource().getName();
259 startTime = System.currentTimeMillis();
260 log.info( "start transfer of {}", transferEvent.getResource().getName() );
263 public void transferProgress( TransferEvent transferEvent, byte[] buffer, int length )
265 log.debug( "transfer of {} : {}/{}",
266 Arrays.asList( transferEvent.getResource().getName(), buffer.length, length ).toArray() );
269 public void transferCompleted( TransferEvent transferEvent )
271 resourceName = transferEvent.getResource().getName();
272 long endTime = System.currentTimeMillis();
273 log.info( "end of transfer file {}: {}s", transferEvent.getResource().getName(),
274 ( endTime - startTime ) / 1000 );
277 public void transferError( TransferEvent transferEvent )
279 log.info( "error of transfer file {}: {}", Arrays.asList( transferEvent.getResource().getName(),
280 transferEvent.getException().getMessage() ).toArray(
281 new Object[2] ), transferEvent.getException() );
284 public void debug( String message )
286 log.debug( "transfer debug {}", message );
290 private static class WagonResourceFetcher
291 implements ResourceFetcher
296 File tempIndexDirectory;
300 RemoteRepository remoteRepository;
302 private WagonResourceFetcher( Logger log, File tempIndexDirectory, Wagon wagon,
303 RemoteRepository remoteRepository )
306 this.tempIndexDirectory = tempIndexDirectory;
308 this.remoteRepository = remoteRepository;
311 public void connect( String id, String url )
317 public void disconnect()
323 public InputStream retrieve( String name )
324 throws IOException, FileNotFoundException
328 log.info( "index update retrieve file, name:{}", name );
329 File file = new File( tempIndexDirectory, name );
335 wagon.get( addParameters( name, this.remoteRepository ), file );
336 return new FileInputStream( file );
338 catch ( AuthorizationException e )
340 throw new IOException( e.getMessage() );
342 catch ( TransferFailedException e )
344 throw new IOException( e.getMessage() );
346 catch ( ResourceDoesNotExistException e )
348 throw new FileNotFoundException( e.getMessage() );
352 // FIXME remove crappy copy/paste
353 protected String addParameters( String path, RemoteRepository remoteRepository )
355 if ( remoteRepository.getExtraParameters().isEmpty() )
360 boolean question = false;
362 StringBuilder res = new StringBuilder( path == null ? "" : path );
364 for ( Map.Entry<String, String> entry : remoteRepository.getExtraParameters().entrySet() )
368 res.append( '?' ).append( entry.getKey() ).append( '=' ).append( entry.getValue() );
372 return res.toString();