package org.eclipse.aether.connector.basic;
   
   /*
    * 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 java.io.File;
  import java.io.IOException;
  import java.net.URI;
  import java.util.Collection;
  import java.util.HashMap;
  import java.util.HashSet;
  import java.util.Map;
  import java.util.UUID;
  
  import org.eclipse.aether.spi.connector.checksum.ChecksumAlgorithmFactory;
  import org.eclipse.aether.spi.connector.checksum.ChecksumPolicy;
  import org.eclipse.aether.spi.connector.checksum.ChecksumPolicy.ChecksumKind;
  import org.eclipse.aether.spi.connector.layout.RepositoryLayout.ChecksumLocation;
  import org.eclipse.aether.spi.io.FileProcessor;
  import org.eclipse.aether.transfer.ChecksumFailureException;
  import org.slf4j.Logger;
  import org.slf4j.LoggerFactory;
  
  /**
   * Performs checksum validation for a downloaded file.
   */
  final class ChecksumValidator
  {
  
      interface ChecksumFetcher
      {
  
          /**
           * Fetches the checksums from remote location into provided local file. The checksums fetched in this way
           * are of kind {@link ChecksumKind#REMOTE_EXTERNAL}.
           */
          boolean fetchChecksum( URI remote, File local )
              throws Exception;
  
      }
  
      private static final Logger LOGGER = LoggerFactory.getLogger( ChecksumValidator.class );
  
      private final File dataFile;
  
      private final Collection<ChecksumAlgorithmFactory> checksumAlgorithmFactories;
  
      private final Collection<File> tempFiles;
  
      private final FileProcessor fileProcessor;
  
      private final ChecksumFetcher checksumFetcher;
  
      private final ChecksumPolicy checksumPolicy;
  
      private final Map<String, String> providedChecksums;
  
      private final Collection<ChecksumLocation> checksumLocations;
  
      private final Map<File, Object> checksumFiles;
  
      ChecksumValidator( File dataFile,
                         Collection<ChecksumAlgorithmFactory> checksumAlgorithmFactories,
                         FileProcessor fileProcessor,
                         ChecksumFetcher checksumFetcher,
                         ChecksumPolicy checksumPolicy,
                         Map<String, String> providedChecksums,
                         Collection<ChecksumLocation> checksumLocations )
      {
          this.dataFile = dataFile;
          this.checksumAlgorithmFactories = checksumAlgorithmFactories;
          this.tempFiles = new HashSet<>();
          this.fileProcessor = fileProcessor;
          this.checksumFetcher = checksumFetcher;
          this.checksumPolicy = checksumPolicy;
          this.providedChecksums = providedChecksums;
          this.checksumLocations = checksumLocations;
          this.checksumFiles = new HashMap<>();
      }
  
      public ChecksumCalculator newChecksumCalculator( File targetFile )
      {
          if ( checksumPolicy != null )
         {
             return ChecksumCalculator.newInstance( targetFile, checksumAlgorithmFactories );
         }
         return null;
     }
 
     public void validate( Map<String, ?> actualChecksums, Map<String, ?> includedChecksums )
         throws ChecksumFailureException
     {
         if ( checksumPolicy == null )
         {
             return;
         }
         if ( providedChecksums != null
                && validateChecksums( actualChecksums, ChecksumKind.PROVIDED, providedChecksums ) )
         {
             return;
         }
         if ( includedChecksums != null
                && validateChecksums( actualChecksums, ChecksumKind.REMOTE_INCLUDED, includedChecksums ) )
         {
             return;
         }
         if ( !checksumLocations.isEmpty() )
         {
             if ( validateExternalChecksums( actualChecksums ) )
             {
                 return;
             }
             checksumPolicy.onNoMoreChecksums();
         }
     }
 
     private boolean validateChecksums( Map<String, ?> actualChecksums, ChecksumKind kind, Map<String, ?> checksums )
         throws ChecksumFailureException
     {
         for ( Map.Entry<String, ?> entry : checksums.entrySet() )
         {
             String algo = entry.getKey();
             Object calculated = actualChecksums.get( algo );
             if ( !( calculated instanceof String ) )
             {
                 continue;
             }
             ChecksumAlgorithmFactory checksumAlgorithmFactory = checksumAlgorithmFactories.stream()
                     .filter( a -> a.getName().equals( algo ) )
                     .findFirst()
                     .orElse( null );
             if ( checksumAlgorithmFactory == null )
             {
                 continue;
             }
 
             String actual = String.valueOf( calculated );
             String expected = entry.getValue().toString();
             checksumFiles.put( getChecksumFile( checksumAlgorithmFactory ), expected );
 
             if ( !isEqualChecksum( expected, actual ) )
             {
                 checksumPolicy.onChecksumMismatch( checksumAlgorithmFactory.getName(), kind,
                     new ChecksumFailureException( expected, kind.name(), actual )
                 );
             }
             else if ( checksumPolicy.onChecksumMatch( checksumAlgorithmFactory.getName(), kind ) )
             {
                 return true;
             }
         }
         return false;
     }
 
     private boolean validateExternalChecksums( Map<String, ?> actualChecksums )
         throws ChecksumFailureException
     {
         for ( ChecksumLocation checksumLocation : checksumLocations )
         {
             ChecksumAlgorithmFactory factory = checksumLocation.getChecksumAlgorithmFactory();
             Object calculated = actualChecksums.get( factory.getName() );
             if ( calculated instanceof Exception )
             {
                 checksumPolicy.onChecksumError(
                         factory.getName(), ChecksumKind.REMOTE_EXTERNAL,
                         new ChecksumFailureException( (Exception) calculated )
                 );
                 continue;
             }
             try
             {
                 File checksumFile = getChecksumFile( checksumLocation.getChecksumAlgorithmFactory() );
                 File tmp = createTempFile( checksumFile );
                 try
                 {
                     if ( !checksumFetcher.fetchChecksum(
                         checksumLocation.getLocation(), tmp
                     ) )
                     {
                         continue;
                     }
                 }
                 catch ( Exception e )
                 {
                     checksumPolicy.onChecksumError(
                         factory.getName(), ChecksumKind.REMOTE_EXTERNAL, new ChecksumFailureException( e )
                     );
                     continue;
                 }
 
                 String actual = String.valueOf( calculated );
                 String expected = fileProcessor.readChecksum( tmp );
                 checksumFiles.put( checksumFile, tmp );
 
                 if ( !isEqualChecksum( expected, actual ) )
                 {
                     checksumPolicy.onChecksumMismatch(
                         factory.getName(), ChecksumKind.REMOTE_EXTERNAL,
                           new ChecksumFailureException( expected, ChecksumKind.REMOTE_EXTERNAL.name(), actual )
                     );
                 }
                 else if ( checksumPolicy.onChecksumMatch( factory.getName(), ChecksumKind.REMOTE_EXTERNAL ) )
                 {
                     return true;
                 }
             }
             catch ( IOException e )
             {
                 checksumPolicy.onChecksumError(
                     factory.getName(), ChecksumKind.REMOTE_EXTERNAL, new ChecksumFailureException( e )
                 );
             }
         }
         return false;
     }
 
     private static boolean isEqualChecksum( String expected, String actual )
     {
         return expected.equalsIgnoreCase( actual );
     }
 
     private File getChecksumFile( ChecksumAlgorithmFactory factory )
     {
         return new File( dataFile.getPath() + '.' + factory.getFileExtension() );
     }
 
     private File createTempFile( File path )
         throws IOException
     {
         File file =
             File.createTempFile( path.getName() + "-"
                 + UUID.randomUUID().toString().replace( "-", "" ).substring( 0, 8 ), ".tmp", path.getParentFile() );
         tempFiles.add( file );
         return file;
     }
 
     private void clearTempFiles()
     {
         for ( File file : tempFiles )
         {
             if ( !file.delete() && file.exists() )
             {
                 LOGGER.debug( "Could not delete temporary file {}", file );
             }
         }
         tempFiles.clear();
     }
 
     public void retry()
     {
         checksumPolicy.onTransferRetry();
         checksumFiles.clear();
         clearTempFiles();
     }
 
     public boolean handle( ChecksumFailureException exception )
     {
         return checksumPolicy.onTransferChecksumFailure( exception );
     }
 
     public void commit()
     {
         for ( Map.Entry<File, Object> entry : checksumFiles.entrySet() )
         {
             File checksumFile = entry.getKey();
             Object tmp = entry.getValue();
             try
             {
                 if ( tmp instanceof File )
                 {
                     fileProcessor.move( (File) tmp, checksumFile );
                     tempFiles.remove( tmp );
                 }
                 else
                 {
                     fileProcessor.writeChecksum( checksumFile, String.valueOf( tmp ) );
                 }
             }
             catch ( IOException e )
             {
                 LOGGER.debug( "Failed to write checksum file {}", checksumFile, e );
             }
         }
         checksumFiles.clear();
     }
 
     public void close()
     {
         clearTempFiles();
     }
 
 }