archiva/archiva-modules/archiva-base/archiva-repository-admin/archiva-repository-admin-default/src/main/java/org/apache/archiva/admin/repository/managed/DefaultManagedRepositoryAdmin.java

package org.apache.archiva.admin.repository.managed;
/*
 * 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.AuditInformation;
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.admin.repository.AbstractRepositoryAdmin;
import org.apache.archiva.components.cache.Cache;
import org.apache.archiva.components.taskqueue.TaskQueueException;
import org.apache.archiva.configuration.model.Configuration;
import org.apache.archiva.configuration.model.ManagedRepositoryConfiguration;
import org.apache.archiva.configuration.model.ProxyConnectorConfiguration;
import org.apache.archiva.indexer.ArchivaIndexManager;
import org.apache.archiva.indexer.IndexManagerFactory;
import org.apache.archiva.indexer.IndexUpdateFailedException;
import org.apache.archiva.metadata.model.facets.AuditEvent;
import org.apache.archiva.metadata.repository.MetadataRepository;
import org.apache.archiva.metadata.repository.MetadataRepositoryException;
import org.apache.archiva.metadata.repository.MetadataSessionException;
import org.apache.archiva.metadata.repository.RepositorySession;
import org.apache.archiva.metadata.repository.RepositorySessionFactory;
import org.apache.archiva.metadata.repository.stats.model.RepositoryStatisticsManager;
import org.apache.archiva.redback.role.RoleManager;
import org.apache.archiva.redback.role.RoleManagerException;
import org.apache.archiva.repository.ReleaseScheme;
import org.apache.archiva.repository.RepositoryException;
import org.apache.archiva.repository.RepositoryRegistry;
import org.apache.archiva.repository.base.RepositoryHandlerDependencies;
import org.apache.archiva.repository.features.ArtifactCleanupFeature;
import org.apache.archiva.repository.features.IndexCreationFeature;
import org.apache.archiva.repository.features.StagingRepositoryFeature;
import org.apache.archiva.scheduler.repository.model.RepositoryArchivaTaskScheduler;
import org.apache.archiva.scheduler.repository.model.RepositoryTask;
import org.apache.archiva.security.common.ArchivaRoleConstants;
import org.apache.commons.lang3.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Service;

import javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;
import javax.inject.Inject;
import javax.inject.Named;
import java.io.IOException;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.stream.Collectors;

/**
 * FIXME review the staging mechanism to have a per user session one
 *
 * @author Olivier Lamy
 */
@Service("managedRepositoryAdmin#default")
public class DefaultManagedRepositoryAdmin
    extends AbstractRepositoryAdmin
    implements ManagedRepositoryAdmin
{

    private Logger log = LoggerFactory.getLogger( getClass() );

    public static final String STAGE_REPO_ID_END = "-stage";


    @Inject
    private RepositoryRegistry repositoryRegistry;

    @SuppressWarnings( "unused" )
    @Inject
    private RepositoryHandlerDependencies managedRepositoryHandler;

    @Inject
    @Named(value = "archivaTaskScheduler#repository")
    private RepositoryArchivaTaskScheduler repositoryTaskScheduler;

    /**
     * FIXME: this could be multiple implementations and needs to be configured.
     */
    @Inject
    private RepositorySessionFactory repositorySessionFactory;

    @Inject
    private RepositoryStatisticsManager repositoryStatisticsManager;

    @Inject
    protected RoleManager roleManager;

    @Inject
    @Named(value = "cache#namespaces")
    private Cache<String, List<String>> namespacesCache;

    @Inject
    private IndexManagerFactory indexManagerFactory;




    @PostConstruct
    public void initialize()
        throws RepositoryAdminException, RoleManagerException
    {
        // initialize index context on start and check roles here
        for ( ManagedRepository managedRepository : getManagedRepositories() )
        {
            log.debug("Initializating {}", managedRepository.getId());
            addRepositoryRoles( managedRepository.getId() );

        }
    }

    @PreDestroy
    public void shutdown()
        throws RepositoryAdminException
    {
    }

    /*
     * Conversion between the repository from the registry and the serialized DTO for the admin API
     */
    private ManagedRepository convertRepo( org.apache.archiva.repository.ManagedRepository repo ) {
        if (repo==null) {
            return null;
        }
        ManagedRepository adminRepo = new ManagedRepository( getArchivaConfiguration().getDefaultLocale() );
        setBaseRepoAttributes( adminRepo, repo );
        adminRepo.setLocation( convertUriToString( repo.getLocation()) );
        adminRepo.setReleases(repo.getActiveReleaseSchemes().contains( ReleaseScheme.RELEASE ));
        adminRepo.setSnapshots( repo.getActiveReleaseSchemes().contains(ReleaseScheme.SNAPSHOT) );
        adminRepo.setBlockRedeployments( repo.blocksRedeployments() );
        adminRepo.setCronExpression( repo.getSchedulingDefinition() );
        if (repo.supportsFeature( IndexCreationFeature.class )) {
            IndexCreationFeature icf = repo.getFeature( IndexCreationFeature.class );
            adminRepo.setSkipPackedIndexCreation( icf.isSkipPackedIndexCreation() );
        }
        adminRepo.setScanned( repo.isScanned() );
        if (repo.supportsFeature( ArtifactCleanupFeature.class) ) {
            ArtifactCleanupFeature acf = repo.getFeature( ArtifactCleanupFeature.class );
            adminRepo.setRetentionPeriod( acf.getRetentionPeriod().getDays() );
            adminRepo.setRetentionCount( acf.getRetentionCount() );
            adminRepo.setDeleteReleasedSnapshots( acf.isDeleteReleasedSnapshots() );

        }
        if (repo.supportsFeature( StagingRepositoryFeature.class )) {
            StagingRepositoryFeature stf = repo.getFeature( StagingRepositoryFeature.class );
            adminRepo.setStageRepoNeeded( stf.isStageRepoNeeded() );
            if (stf.getStagingRepository()!=null) {
                adminRepo.setStagingRepository( convertRepo( stf.getStagingRepository() ) );
            }
        }
        return adminRepo;
    }

    private ManagedRepositoryConfiguration getRepositoryConfiguration(ManagedRepository repo) {
        ManagedRepositoryConfiguration repoConfig = new ManagedRepositoryConfiguration();
        setBaseRepoAttributes( repoConfig, repo );
        repoConfig.setBlockRedeployments( repo.isBlockRedeployments( ) );
        repoConfig.setReleases( repo.isReleases() );
        repoConfig.setSnapshots( repo.isSnapshots() );
        repoConfig.setScanned( repo.isScanned() );
        repoConfig.setLocation( getRepositoryCommonValidator().removeExpressions( repo.getLocation() ) );
        repoConfig.setRefreshCronExpression( repo.getCronExpression() );
        repoConfig.setRetentionPeriod( repo.getRetentionPeriod() );
        repoConfig.setRetentionCount( repo.getRetentionCount());
        repoConfig.setDeleteReleasedSnapshots( repo.isDeleteReleasedSnapshots() );
        repoConfig.setSkipPackedIndexCreation( repo.isSkipPackedIndexCreation());
        repoConfig.setStageRepoNeeded( repo.isStageRepoNeeded() );

        return repoConfig;
    }

    @Override
    public List<ManagedRepository> getManagedRepositories()
        throws RepositoryAdminException
    {

        return repositoryRegistry.getManagedRepositories().stream().map( rep -> this.convertRepo( rep ) ).collect( Collectors.toList());
    }

    @Override
    public Map<String, ManagedRepository> getManagedRepositoriesAsMap()
        throws RepositoryAdminException
    {
        return repositoryRegistry.getManagedRepositories().stream().collect( Collectors.toMap( e -> e.getId(), e -> convertRepo( e ) ) );
    }

    @Override
    public ManagedRepository getManagedRepository( String repositoryId )
        throws RepositoryAdminException
    {
        return convertRepo( repositoryRegistry.getManagedRepository( repositoryId ) );
    }

    @Override
    public Boolean addManagedRepository( ManagedRepository managedRepository, boolean needStageRepo,
                                         AuditInformation auditInformation )
        throws RepositoryAdminException
    {
        log.debug("addManagedRepository {}, {}, {}", managedRepository.getId(), needStageRepo, auditInformation);

        getRepositoryCommonValidator().basicValidation( managedRepository, false );
        getRepositoryCommonValidator().validateManagedRepository( managedRepository );
        triggerAuditEvent( managedRepository.getId(), null, AuditEvent.ADD_MANAGED_REPO, auditInformation );
        ManagedRepositoryConfiguration repoConfig = getRepositoryConfiguration( managedRepository );
        if (needStageRepo) {
            repoConfig.setStageRepoNeeded( true );
        }
        Configuration configuration = getArchivaConfiguration().getConfiguration();
        try
        {
            org.apache.archiva.repository.ManagedRepository newRepo = repositoryRegistry.putRepository( repoConfig );
            log.debug("Added new repository {}", newRepo.getId());
            addRepositoryRoles( newRepo.getId() );
            //MRM-1342 Repository statistics report doesn't appear to be working correctly
            //scan repository when adding of repository is successful
            try
            {
                if ( newRepo.isScanned())
                {
                    scanRepository( newRepo.getId(), true );
                }

                org.apache.archiva.repository.ManagedRepository stagingRepo = newRepo.getFeature( StagingRepositoryFeature.class ).getStagingRepository( );
                if ( stagingRepo!=null)
                {
                    if (stagingRepo.isScanned()) {
                        scanRepository( stagingRepo.getId(), true );
                    }
                    addRepositoryRoles( stagingRepo.getId( ) );
                }
            }
            catch ( Exception e )
            {
                log.warn("Unable to scan repository [{}]: {}", newRepo.getId(), e.getMessage(), e);
            }
        }
        catch ( RepositoryException e )
        {
            log.error("Could not add managed repository {}"+managedRepository);
            throw new RepositoryAdminException( "Could not add repository "+e.getMessage() );
        }
        catch ( RoleManagerException e )
        {
            log.error("Could not add repository roles for repository [{}]: {}", managedRepository.getId(), e.getMessage(), e);
            throw new RepositoryAdminException( "Could not add roles to repository "+e.getMessage() );
        }
        return Boolean.TRUE;

    }



    @Override
    public Boolean deleteManagedRepository( String repositoryId, AuditInformation auditInformation,
                                            boolean deleteContent )
        throws RepositoryAdminException
    {
        Configuration config = getArchivaConfiguration().getConfiguration();
        ManagedRepositoryConfiguration repoConfig=config.findManagedRepositoryById( repositoryId );
        if (repoConfig!=null) {

            log.debug("Repo location " + repoConfig.getLocation());

            org.apache.archiva.repository.ManagedRepository repo = repositoryRegistry.getManagedRepository(repositoryId);
            org.apache.archiva.repository.ManagedRepository stagingRepository = null;
            if (repo != null) {
                if (repo.supportsFeature(StagingRepositoryFeature.class)) {
                    stagingRepository = repo.getFeature( StagingRepositoryFeature.class ).getStagingRepository();
                }
            } else {
                throw new RepositoryAdminException("A repository with that id does not exist");
            }

            triggerAuditEvent(repositoryId, null, AuditEvent.DELETE_MANAGED_REPO, auditInformation);
            if (repoConfig != null) {
                deleteManagedRepository(repoConfig, deleteContent, config, false);
            }


            // stage repo exists ?
            if (stagingRepository != null) {
                // do not trigger event when deleting the staged one
                ManagedRepositoryConfiguration stagingRepositoryConfig = config.findManagedRepositoryById(stagingRepository.getId());
                if (stagingRepositoryConfig != null) {
                    deleteManagedRepository(stagingRepositoryConfig, deleteContent, config, true);
                }
            }

            try {
                saveConfiguration(config);
            } catch (Exception e) {
                throw new RepositoryAdminException("Error saving configuration for delete action" + e.getMessage(), e);
            }

            return Boolean.TRUE;
        } else {
            return Boolean.FALSE;
        }
    }

    private Boolean deleteManagedRepository( ManagedRepositoryConfiguration repository, boolean deleteContent,
                                             Configuration config, boolean stagedOne )
        throws RepositoryAdminException
    {

        if ( !stagedOne )
        {
            boolean success=false;
            try(RepositorySession repositorySession = getRepositorySessionFactory().createSession())
            {
                MetadataRepository metadataRepository = repositorySession.getRepository();
                metadataRepository.removeRepository(repositorySession , repository.getId() );
                //invalidate cache
                namespacesCache.remove( repository.getId() );
                repositorySession.save();
                success=true;
            }
            catch ( MetadataRepositoryException e )
            {
                //throw new RepositoryAdminException( e.getMessage(), e );
                log.warn( "skip error during removing repository from MetadataRepository:{}", e.getMessage(), e );
                success = false;
            } catch (MetadataSessionException e) {
                log.warn( "skip error during removing repository from MetadataRepository:{}", e.getMessage(), e );
                success = false;
            }
            if (success)
            {
                log.debug( "call repositoryStatisticsManager.deleteStatistics" );
                try
                {
                    getRepositoryStatisticsManager( ).deleteStatistics( repository.getId( ) );
                }
                catch ( MetadataRepositoryException e )
                {
                    e.printStackTrace( );
                }
            }

        }


        // olamy: copy list for reading as a unit test in webapp fail with ConcurrentModificationException
        List<ProxyConnectorConfiguration> proxyConnectors = new ArrayList<>( config.getProxyConnectors() );
        for ( ProxyConnectorConfiguration proxyConnector : proxyConnectors )
        {
            if ( StringUtils.equals( proxyConnector.getSourceRepoId(), repository.getId() ) )
            {
                config.removeProxyConnector( proxyConnector );
            }
        }
        try
        {
            removeRepositoryRoles( repository );
        }
        catch ( RoleManagerException e )
        {
            throw new RepositoryAdminException(
                "fail to remove repository roles for repository " + repository.getId() + " : " + e.getMessage(), e );
        }

        try {
            org.apache.archiva.repository.ManagedRepository repo = repositoryRegistry.getManagedRepository( repository.getId( ) );
            if (repo!=null)
            {
                repositoryRegistry.removeRepository( repo, config );
                if ( deleteContent )
                {
                    // TODO could be async ? as directory can be huge
                    Path dir = Paths.get( repository.getLocation( ) );
                    org.apache.archiva.common.utils.FileUtils.deleteQuietly( dir );
                }
            }
        } catch (RepositoryException e) {
            throw new RepositoryAdminException("Removal of repository "+repository.getId()+ " failed: "+e.getMessage());
        }

        saveConfiguration( config );


        return Boolean.TRUE;
    }

    ArchivaIndexManager getIndexManager(ManagedRepository managedRepository) {
        org.apache.archiva.repository.ManagedRepository repo = getRepositoryRegistry().getManagedRepository(managedRepository.getId());
        return indexManagerFactory.getIndexManager(repo.getType());
    }

    @Override
    public Boolean updateManagedRepository( ManagedRepository managedRepository, boolean needStageRepo,
                                            AuditInformation auditInformation, boolean resetStats )
        throws RepositoryAdminException
    {

        log.debug( "updateManagedConfiguration repo {} needStage {} resetStats {} ", managedRepository, needStageRepo,
                   resetStats );

        // Ensure that the fields are valid.

        getRepositoryCommonValidator().basicValidation( managedRepository, true );

        getRepositoryCommonValidator().validateManagedRepository( managedRepository );

        ManagedRepositoryConfiguration updatedRepoConfig = getRepositoryConfiguration( managedRepository );
        updatedRepoConfig.setStageRepoNeeded( needStageRepo );

        org.apache.archiva.repository.ManagedRepository oldRepo = repositoryRegistry.getManagedRepository( managedRepository.getId( ) );
        boolean stagingExists = false;
        if (oldRepo.supportsFeature( StagingRepositoryFeature.class ) ){
            stagingExists = oldRepo.getFeature( StagingRepositoryFeature.class ).getStagingRepository() != null;
        }
        boolean updateIndexContext = !StringUtils.equals( updatedRepoConfig.getIndexDir(), managedRepository.getIndexDirectory() );
        org.apache.archiva.repository.ManagedRepository newRepo;
        // TODO remove content from old if path has changed !!!!!
        try
        {
            newRepo = repositoryRegistry.putRepository( updatedRepoConfig );
            if (newRepo.supportsFeature( StagingRepositoryFeature.class )) {
                org.apache.archiva.repository.ManagedRepository stagingRepo = newRepo.getFeature( StagingRepositoryFeature.class ).getStagingRepository( );
                if (stagingRepo!=null && !stagingExists)
                {
                    triggerAuditEvent( stagingRepo.getId(), null, AuditEvent.ADD_MANAGED_REPO, auditInformation );
                    addRepositoryRoles( stagingRepo.getId( ) );
                }
            }


        }
        catch ( RepositoryException e )
        {
            log.error("Could not update repository {}: {}", managedRepository.getId(), e.getMessage(), e);
            throw new RepositoryAdminException( "Could not update repository "+managedRepository.getId());
        }
        catch ( RoleManagerException e ) {
            log.error("Error during role update of stage repo {}", managedRepository.getId(), e);
            throw new RepositoryAdminException( "Could not update repository "+managedRepository.getId());
        }
        triggerAuditEvent( managedRepository.getId(), null, AuditEvent.MODIFY_MANAGED_REPO,
            auditInformation );
        // Save the repository configuration.
        RepositorySession repositorySession = null;
        try
        {
            repositorySession = getRepositorySessionFactory().createSession();
        }
        catch ( MetadataRepositoryException e )
        {
            e.printStackTrace( );
        }

        try
        {

            if ( resetStats )
            {
                log.debug( "call repositoryStatisticsManager.deleteStatistics" );
                getRepositoryStatisticsManager().deleteStatistics(
                    managedRepository.getId() );
                repositorySession.save();
            }

        }
        catch (MetadataRepositoryException | MetadataSessionException e )
        {
            throw new RepositoryAdminException( e.getMessage(), e );
        }
        finally
        {
            repositorySession.close();
        }

        if ( updateIndexContext )
        {
            try
            {

                repositoryRegistry.resetIndexingContext(newRepo);
            } catch (IndexUpdateFailedException e) {
                e.printStackTrace();
            }
        }

        return true;
    }

    //--------------------------
    // utils methods
    //--------------------------


    protected void addRepository( ManagedRepositoryConfiguration repository, Configuration configuration )
        throws RepositoryAdminException, IOException
    {
        try
        {
            getRepositoryRegistry().putRepository( repository, configuration );
        }
        catch ( RepositoryException e )
        {
            throw new RepositoryAdminException( "Could not add the repository to the registry. Cause: "+e.getMessage() );
        }

    }


    public Boolean scanRepository( String repositoryId, boolean fullScan )
    {
        if ( getRepositoryTaskScheduler().isProcessingRepositoryTask( repositoryId ) )
        {
            log.info( "scanning of repository with id {} already scheduled", repositoryId );
        }
        RepositoryTask task = new RepositoryTask();
        task.setRepositoryId( repositoryId );
        task.setScanAll( fullScan );
        try
        {
            getRepositoryTaskScheduler().queueTask( task );
        }
        catch ( TaskQueueException e )
        {
            log.error( "failed to schedule scanning of repo with id {}", repositoryId, e );
            return false;
        }
        return true;
    }


    private void addRepositoryRoles( String repoId )
        throws RoleManagerException
    {
        // TODO: double check these are configured on start up
        // TODO: belongs in the business logic

        if ( !getRoleManager().templatedRoleExists( ArchivaRoleConstants.TEMPLATE_REPOSITORY_OBSERVER, repoId ) )
        {
            getRoleManager().createTemplatedRole( ArchivaRoleConstants.TEMPLATE_REPOSITORY_OBSERVER, repoId );
        }

        if ( !getRoleManager().templatedRoleExists( ArchivaRoleConstants.TEMPLATE_REPOSITORY_MANAGER, repoId ) )
        {
            getRoleManager().createTemplatedRole( ArchivaRoleConstants.TEMPLATE_REPOSITORY_MANAGER, repoId );
        }
    }

    protected void removeRepositoryRoles( ManagedRepositoryConfiguration existingRepository )
        throws RoleManagerException
    {
        String repoId = existingRepository.getId();

        if ( getRoleManager().templatedRoleExists( ArchivaRoleConstants.TEMPLATE_REPOSITORY_MANAGER, repoId ) )
        {
            getRoleManager().removeTemplatedRole( ArchivaRoleConstants.TEMPLATE_REPOSITORY_MANAGER, repoId );
        }

        if ( getRoleManager().templatedRoleExists( ArchivaRoleConstants.TEMPLATE_REPOSITORY_OBSERVER, repoId ) )
        {
            getRoleManager().removeTemplatedRole( ArchivaRoleConstants.TEMPLATE_REPOSITORY_OBSERVER, repoId );
        }

        log.debug( "removed user roles associated with repository {}", repoId );
    }

    //--------------------------
    // setters/getters
    //--------------------------


    public RoleManager getRoleManager()
    {
        return roleManager;
    }

    public void setRoleManager( RoleManager roleManager )
    {
        this.roleManager = roleManager;
    }

    public RepositoryStatisticsManager getRepositoryStatisticsManager()
    {
        return repositoryStatisticsManager;
    }

    public void setRepositoryStatisticsManager( RepositoryStatisticsManager repositoryStatisticsManager )
    {
        this.repositoryStatisticsManager = repositoryStatisticsManager;
    }

    public RepositorySessionFactory getRepositorySessionFactory()
    {
        return repositorySessionFactory;
    }

    public void setRepositorySessionFactory( RepositorySessionFactory repositorySessionFactory )
    {
        this.repositorySessionFactory = repositorySessionFactory;
    }


    public RepositoryArchivaTaskScheduler getRepositoryTaskScheduler()
    {
        return repositoryTaskScheduler;
    }

    public void setRepositoryTaskScheduler( RepositoryArchivaTaskScheduler repositoryTaskScheduler )
    {
        this.repositoryTaskScheduler = repositoryTaskScheduler;
    }


    public RepositoryRegistry getRepositoryRegistry( )
    {
        return repositoryRegistry;
    }

    public void setRepositoryRegistry( RepositoryRegistry repositoryRegistry )
    {
        this.repositoryRegistry = repositoryRegistry;
    }
}