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