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

   1 package org.apache.maven.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 java.io.File;
  23 import java.util.ArrayList;
  24 import java.util.List;
  25 import java.util.Properties;
  26
  27 import org.apache.commons.lang.StringUtils;
  28 import org.apache.maven.archiva.common.utils.Checksums;
  29 import org.slf4j.Logger;
  30 import org.slf4j.LoggerFactory;
  31
  32 /**
  33  * ChecksumPolicy - a policy applied after the download to see if the file has been downloaded
  34  * successfully and completely (or not).
  35  *
  36  * @author <a href="mailto:joakime@apache.org">Joakim Erdfelt</a>
  37  * @version $Id$
  38  *
  39  * @plexus.component role="org.apache.maven.archiva.policies.PostDownloadPolicy"
  40  *                   role-hint="checksum"
  41  */
  42 public class ChecksumPolicy
  43     implements PostDownloadPolicy
  44 {
  45     private Logger log = LoggerFactory.getLogger( ChecksumPolicy.class );
  46
  47     /**
  48      * The IGNORE policy indicates that if the checksum policy is ignored, and
  49      * the state of, contents of, or validity of the checksum files are not
  50      * checked.
  51      */
  52     public static final String IGNORE = "ignore";
  53
  54     /**
  55      * The FAIL policy indicates that if the checksum does not match the
  56      * downloaded file, then remove the downloaded artifact, and checksum
  57      * files, and fail the transfer to the client side.
  58      */
  59     public static final String FAIL = "fail";
  60
  61     /**
  62      * The FIX policy indicates that if the checksum does not match the
  63      * downloaded file, then fix the checksum file locally, and return
  64      * to the client side the corrected checksum.
  65      */
  66     public static final String FIX = "fix";
  67
  68     /**
  69      * @plexus.requirement
  70      */
  71     private Checksums checksums;
  72
  73     private List<String> options = new ArrayList<String>();
  74
  75     public ChecksumPolicy()
  76     {
  77         options.add( FAIL );
  78         options.add( FIX );
  79         options.add( IGNORE );
  80     }
  81
  82     public void applyPolicy( String policySetting, Properties request, File localFile )
  83         throws PolicyViolationException, PolicyConfigurationException
  84     {
  85         if ( !options.contains( policySetting ) )
  86         {
  87             // Not a valid code.
  88             throw new PolicyConfigurationException( "Unknown checksum policy setting [" + policySetting
  89                 + "], valid settings are [" + StringUtils.join( options.iterator(), "," ) + "]" );
  90         }
  91
  92         if ( IGNORE.equals( policySetting ) )
  93         {
  94             // Ignore.
  95             log.debug( "Checksum policy set to IGNORE." );
  96             return;
  97         }
  98
  99         if ( !localFile.exists() )
 100         {
 101             // Local File does not exist.
 102             throw new PolicyViolationException( "Checksum policy failure, local file " + localFile.getAbsolutePath()
 103                 + " does not exist to check." );
 104         }
 105
 106         if ( FAIL.equals( policySetting ) )
 107         {
 108             if( checksums.check( localFile ) )
 109             {
 110                 return;
 111             }
 112
 113             File sha1File = new File( localFile.getAbsolutePath() + ".sha1" );
 114             File md5File = new File( localFile.getAbsolutePath() + ".md5" );
 115
 116             // On failure. delete files.
 117             if ( sha1File.exists() )
 118             {
 119                 sha1File.delete();
 120             }
 121
 122             if ( md5File.exists() )
 123             {
 124                 md5File.delete();
 125             }
 126
 127             localFile.delete();
 128             throw new PolicyViolationException( "Checksums do not match, policy set to FAIL, "
 129                 + "deleting checksum files and local file " + localFile.getAbsolutePath() + "." );
 130         }
 131
 132         if ( FIX.equals( policySetting ) )
 133         {
 134             if( checksums.update( localFile ) )
 135             {
 136                 log.debug( "Checksum policy set to FIX, checksum files have been updated." );
 137                 return;
 138             }
 139             else
 140             {
 141                 throw new PolicyViolationException( "Checksum policy set to FIX, "
 142                     + "yet unable to update checksums for local file " + localFile.getAbsolutePath() + "." );
 143             }
 144         }
 145
 146         throw new PolicyConfigurationException( "Unable to process checksum policy of [" + policySetting
 147             + "], please file a bug report." );
 148     }
 149
 150     public String getDefaultOption()
 151     {
 152         return FIX;
 153     }
 154
 155     public String getId()
 156     {
 157         return "checksum";
 158     }
 159
 160     public List<String> getOptions()
 161     {
 162         return options;
 163     }
 164 }