source.dussan.org Git - archiva.git/blob

   1 package org.apache.archiva.policies;
   2
   3 /*
   4  * Licensed to the Apache Software Foundation (ASF) under one
   5  * or more contributor license agreements.  See the NOTICE file
   6  * distributed with this work for additional information
   7  * regarding copyright ownership.  The ASF licenses this file
   8  * to you under the Apache License, Version 2.0 (the
   9  * "License"); you may not use this file except in compliance
  10  * with the License.  You may obtain a copy of the License at
  11  *
  12  *  http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing,
  15  * software distributed under the License is distributed on an
  16  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  17  * KIND, either express or implied.  See the License for the
  18  * specific language governing permissions and limitations
  19  * under the License.
  20  */
  21
  22 import org.apache.archiva.checksum.ChecksumAlgorithm;
  23 import org.apache.archiva.checksum.ChecksummedFile;
  24 import org.apache.commons.lang.StringUtils;
  25 import org.slf4j.Logger;
  26 import org.slf4j.LoggerFactory;
  27 import org.springframework.stereotype.Service;
  28
  29 import java.io.File;
  30 import java.util.ArrayList;
  31 import java.util.List;
  32 import java.util.Properties;
  33
  34 /**
  35  * ChecksumPolicy - a policy applied after the download to see if the file has been downloaded
  36  * successfully and completely (or not).
  37  *
  38  * @version $Id$
  39  */
  40 @Service( "postDownloadPolicy#checksum" )
  41 public class ChecksumPolicy
  42     implements PostDownloadPolicy
  43 {
  44     private Logger log = LoggerFactory.getLogger( ChecksumPolicy.class );
  45
  46     /**
  47      * The IGNORE policy indicates that if the checksum policy is ignored, and
  48      * the state of, contents of, or validity of the checksum files are not
  49      * checked.
  50      */
  51     public static final String IGNORE = "ignore";
  52
  53     /**
  54      * The FAIL policy indicates that if the checksum does not match the
  55      * downloaded file, then remove the downloaded artifact, and checksum
  56      * files, and fail the transfer to the client side.
  57      */
  58     public static final String FAIL = "fail";
  59
  60     /**
  61      * The FIX policy indicates that if the checksum does not match the
  62      * downloaded file, then fix the checksum file locally, and return
  63      * to the client side the corrected checksum.
  64      */
  65     public static final String FIX = "fix";
  66
  67     private ChecksumAlgorithm[] algorithms = new ChecksumAlgorithm[]{ ChecksumAlgorithm.SHA1, ChecksumAlgorithm.MD5 };
  68
  69     private List<String> options = new ArrayList<String>( 3 );
  70
  71     public ChecksumPolicy()
  72     {
  73         options.add( FAIL );
  74         options.add( FIX );
  75         options.add( IGNORE );
  76     }
  77
  78     public void applyPolicy( String policySetting, Properties request, File localFile )
  79         throws PolicyViolationException, PolicyConfigurationException
  80     {
  81         if ( "resource".equals( request.getProperty( "filetype" ) ) )
  82         {
  83             return;
  84         }
  85
  86         if ( !options.contains( policySetting ) )
  87         {
  88             // Not a valid code.
  89             throw new PolicyConfigurationException(
  90                 "Unknown checksum policy setting [" + policySetting + "], valid settings are [" + StringUtils.join(
  91                     options.iterator(), "," ) + "]" );
  92         }
  93
  94         if ( IGNORE.equals( policySetting ) )
  95         {
  96             // Ignore.
  97             log.debug( "Checksum policy set to IGNORE." );
  98             return;
  99         }
 100
 101         if ( !localFile.exists() )
 102         {
 103             // Local File does not exist.
 104             throw new PolicyViolationException(
 105                 "Checksum policy failure, local file " + localFile.getAbsolutePath() + " does not exist to check." );
 106         }
 107
 108         if ( FAIL.equals( policySetting ) )
 109         {
 110             ChecksummedFile checksum = new ChecksummedFile( localFile );
 111             if ( checksum.isValidChecksums( algorithms ) )
 112             {
 113                 return;
 114             }
 115
 116             for ( ChecksumAlgorithm algorithm : algorithms )
 117             {
 118                 File file = new File( localFile.getAbsolutePath() + "." + algorithm.getExt() );
 119                 if ( file.exists() )
 120                 {
 121                     file.delete();
 122                 }
 123             }
 124
 125             localFile.delete();
 126             throw new PolicyViolationException(
 127                 "Checksums do not match, policy set to FAIL, " + "deleting checksum files and local file "
 128                     + localFile.getAbsolutePath() + "." );
 129         }
 130
 131         if ( FIX.equals( policySetting ) )
 132         {
 133             ChecksummedFile checksum = new ChecksummedFile( localFile );
 134             if ( checksum.fixChecksums( algorithms ) )
 135             {
 136                 log.debug( "Checksum policy set to FIX, checksum files have been updated." );
 137                 return;
 138             }
 139             else
 140             {
 141                 throw new PolicyViolationException(
 142                     "Checksum policy set to FIX, " + "yet unable to update checksums for local file "
 143                         + localFile.getAbsolutePath() + "." );
 144             }
 145         }
 146
 147         throw new PolicyConfigurationException(
 148             "Unable to process checksum policy of [" + policySetting + "], please file a bug report." );
 149     }
 150
 151     public String getDefaultOption()
 152     {
 153         return FIX;
 154     }
 155
 156     public String getId()
 157     {
 158         return "checksum";
 159     }
 160
 161     public String getName()
 162     {
 163         return "Checksum";
 164     }
 165
 166     public List<String> getOptions()
 167     {
 168         return options;
 169     }
 170 }