package org.apache.archiva.consumers.core.repository;
/*
* 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 org.apache.archiva.admin.model.RepositoryAdminException;
import org.apache.archiva.admin.model.beans.ManagedRepository;
import org.apache.archiva.admin.model.managed.ManagedRepositoryAdmin;
import org.apache.archiva.metadata.repository.MetadataRepository;
import org.apache.archiva.metadata.repository.RepositorySession;
import org.apache.archiva.repository.events.RepositoryListener;
import org.apache.archiva.common.utils.VersionComparator;
import org.apache.archiva.common.utils.VersionUtil;
import org.apache.archiva.model.ArtifactReference;
import org.apache.archiva.model.ProjectReference;
import org.apache.archiva.model.VersionedReference;
import org.apache.archiva.repository.ContentNotFoundException;
import org.apache.archiva.repository.ManagedRepositoryContent;
import org.apache.archiva.repository.RepositoryContentFactory;
import org.apache.archiva.repository.RepositoryException;
import org.apache.archiva.repository.RepositoryNotFoundException;
import org.apache.archiva.repository.layout.LayoutException;
import org.apache.archiva.repository.metadata.MetadataTools;
import org.apache.archiva.repository.metadata.RepositoryMetadataException;
import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
/**
* <p>
* This will look in a single managed repository, and purge any snapshots that are present
* that have a corresponding released version on the same repository.
* </p>
* <p>
* So, if you have the following (presented in the m2/default layout form) ...
* <pre>
* /com/foo/foo-tool/1.0-SNAPSHOT/foo-tool-1.0-SNAPSHOT.jar
* /com/foo/foo-tool/1.1-SNAPSHOT/foo-tool-1.1-SNAPSHOT.jar
* /com/foo/foo-tool/1.2.1-SNAPSHOT/foo-tool-1.2.1-SNAPSHOT.jar
* /com/foo/foo-tool/1.2.1/foo-tool-1.2.1.jar
* /com/foo/foo-tool/2.0-SNAPSHOT/foo-tool-2.0-SNAPSHOT.jar
* /com/foo/foo-tool/2.0/foo-tool-2.0.jar
* /com/foo/foo-tool/2.1-SNAPSHOT/foo-tool-2.1-SNAPSHOT.jar
* </pre>
* then the current highest ranked released (non-snapshot) version is 2.0, which means
* the snapshots from 1.0-SNAPSHOT, 1.1-SNAPSHOT, 1.2.1-SNAPSHOT, and 2.0-SNAPSHOT can
* be purged. Leaving 2.1-SNAPSHOT in alone.
*/
public class CleanupReleasedSnapshotsRepositoryPurge
extends AbstractRepositoryPurge
{
private MetadataTools metadataTools;
private ManagedRepositoryAdmin managedRepositoryAdmin;
private RepositoryContentFactory repoContentFactory;
public CleanupReleasedSnapshotsRepositoryPurge( ManagedRepositoryContent repository, MetadataTools metadataTools,
ManagedRepositoryAdmin managedRepositoryAdmin,
RepositoryContentFactory repoContentFactory,
RepositorySession repositorySession,
List<RepositoryListener> listeners )
{
super( repository, repositorySession, listeners );
this.metadataTools = metadataTools;
this.managedRepositoryAdmin = managedRepositoryAdmin;
this.repoContentFactory = repoContentFactory;
}
@Override
public void process( String path )
throws RepositoryPurgeException
{
try
{
File artifactFile = new File( repository.getRepoRoot(), path );
if ( !artifactFile.exists() )
{
// Nothing to do here, file doesn't exist, skip it.
return;
}
ArtifactReference artifactRef = repository.toArtifactReference( path );
if ( !VersionUtil.isSnapshot( artifactRef.getVersion() ) )
{
// Nothing to do here, not a snapshot, skip it.
return;
}
ProjectReference reference = new ProjectReference();
reference.setGroupId( artifactRef.getGroupId() );
reference.setArtifactId( artifactRef.getArtifactId() );
// Gether the released versions
List<String> releasedVersions = new ArrayList<>();
List<ManagedRepository> repos = managedRepositoryAdmin.getManagedRepositories();
for ( ManagedRepository repo : repos )
{
if ( repo.isReleases() )
{
try
{
ManagedRepositoryContent repoContent =
repoContentFactory.getManagedRepositoryContent( repo.getId() );
for ( String version : repoContent.getVersions( reference ) )
{
if ( !VersionUtil.isSnapshot( version ) )
{
releasedVersions.add( version );
}
}
}
catch ( RepositoryNotFoundException e )
{
// swallow
}
catch ( RepositoryException e )
{
// swallow
}
}
}
Collections.sort( releasedVersions, VersionComparator.getInstance() );
// Now clean out any version that is earlier than the highest released version.
boolean needsMetadataUpdate = false;
VersionedReference versionRef = new VersionedReference();
versionRef.setGroupId( artifactRef.getGroupId() );
versionRef.setArtifactId( artifactRef.getArtifactId() );
MetadataRepository metadataRepository = repositorySession.getRepository();
if ( releasedVersions.contains( VersionUtil.getReleaseVersion( artifactRef.getVersion() ) ) )
{
versionRef.setVersion( artifactRef.getVersion() );
repository.deleteVersion( versionRef );
// FIXME: looks incomplete, might not delete related metadata?
for ( RepositoryListener listener : listeners )
{
listener.deleteArtifact( metadataRepository, repository.getId(), artifactRef.getGroupId(),
artifactRef.getArtifactId(), artifactRef.getVersion(),
artifactFile.getName() );
}
needsMetadataUpdate = true;
}
if ( needsMetadataUpdate )
{
updateMetadata( artifactRef );
}
} catch ( RepositoryAdminException e )
{
throw new RepositoryPurgeException( e.getMessage(), e );
}
catch ( LayoutException e )
{
log.debug( "Not processing file that is not an artifact: {}", e.getMessage() );
}
catch ( ContentNotFoundException e )
{
throw new RepositoryPurgeException( e.getMessage(), e );
}
}
private void updateMetadata( ArtifactReference artifact )
{
VersionedReference versionRef = new VersionedReference();
versionRef.setGroupId( artifact.getGroupId() );
versionRef.setArtifactId( artifact.getArtifactId() );
versionRef.setVersion( artifact.getVersion() );
ProjectReference projectRef = new ProjectReference();
projectRef.setGroupId( artifact.getGroupId() );
projectRef.setArtifactId( artifact.getArtifactId() );
try
{
metadataTools.updateMetadata( repository, versionRef );
}
catch ( ContentNotFoundException e )
{
// Ignore. (Just means we have no snapshot versions left to reference).
}
catch ( RepositoryMetadataException e )
{
// Ignore.
}
catch ( IOException e )
{
// Ignore.
}
catch ( LayoutException e )
{
// Ignore.
}
try
{
metadataTools.updateMetadata( repository, projectRef );
}
catch ( ContentNotFoundException e )
{
// Ignore. (Just means we have no snapshot versions left to reference).
}
catch ( RepositoryMetadataException e )
{
// Ignore.
}
catch ( IOException e )
{
// Ignore.
}
catch ( LayoutException e )
{
// Ignore.
}
}
}