| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="en"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span>package org.apache.archiva.policies;<a name="line.1"></a> |
| <span class="sourceLineNo">002</span><a name="line.2"></a> |
| <span class="sourceLineNo">003</span>/*<a name="line.3"></a> |
| <span class="sourceLineNo">004</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.4"></a> |
| <span class="sourceLineNo">005</span> * or more contributor license agreements. See the NOTICE file<a name="line.5"></a> |
| <span class="sourceLineNo">006</span> * distributed with this work for additional information<a name="line.6"></a> |
| <span class="sourceLineNo">007</span> * regarding copyright ownership. The ASF licenses this file<a name="line.7"></a> |
| <span class="sourceLineNo">008</span> * to you under the Apache License, Version 2.0 (the<a name="line.8"></a> |
| <span class="sourceLineNo">009</span> * "License"); you may not use this file except in compliance<a name="line.9"></a> |
| <span class="sourceLineNo">010</span> * with the License. You may obtain a copy of the License at<a name="line.10"></a> |
| <span class="sourceLineNo">011</span> *<a name="line.11"></a> |
| <span class="sourceLineNo">012</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.12"></a> |
| <span class="sourceLineNo">013</span> *<a name="line.13"></a> |
| <span class="sourceLineNo">014</span> * Unless required by applicable law or agreed to in writing,<a name="line.14"></a> |
| <span class="sourceLineNo">015</span> * software distributed under the License is distributed on an<a name="line.15"></a> |
| <span class="sourceLineNo">016</span> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.16"></a> |
| <span class="sourceLineNo">017</span> * KIND, either express or implied. See the License for the<a name="line.17"></a> |
| <span class="sourceLineNo">018</span> * specific language governing permissions and limitations<a name="line.18"></a> |
| <span class="sourceLineNo">019</span> * under the License.<a name="line.19"></a> |
| <span class="sourceLineNo">020</span> */<a name="line.20"></a> |
| <span class="sourceLineNo">021</span><a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import org.apache.archiva.checksum.ChecksumAlgorithm;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.apache.archiva.checksum.ChecksummedFile;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.apache.commons.lang.StringUtils;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.slf4j.Logger;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.slf4j.LoggerFactory;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.springframework.stereotype.Service;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span><a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import java.io.File;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import java.util.ArrayList;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import java.util.List;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import java.util.Properties;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span><a name="line.33"></a> |
| <span class="sourceLineNo">034</span>/**<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * ChecksumPolicy - a policy applied after the download to see if the file has been downloaded<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * successfully and completely (or not).<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> *<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> *<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> */<a name="line.39"></a> |
| <span class="sourceLineNo">040</span>@Service( "postDownloadPolicy#checksum" )<a name="line.40"></a> |
| <span class="sourceLineNo">041</span>public class ChecksumPolicy<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> implements PostDownloadPolicy<a name="line.42"></a> |
| <span class="sourceLineNo">043</span>{<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> private Logger log = LoggerFactory.getLogger( ChecksumPolicy.class );<a name="line.44"></a> |
| <span class="sourceLineNo">045</span><a name="line.45"></a> |
| <span class="sourceLineNo">046</span> /**<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * The IGNORE policy indicates that if the checksum policy is ignored, and<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * the state of, contents of, or validity of the checksum files are not<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * checked.<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> */<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> public static final String IGNORE = "ignore";<a name="line.51"></a> |
| <span class="sourceLineNo">052</span><a name="line.52"></a> |
| <span class="sourceLineNo">053</span> /**<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * The FAIL policy indicates that if the checksum does not match the<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * downloaded file, then remove the downloaded artifact, and checksum<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * files, and fail the transfer to the client side.<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> */<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> public static final String FAIL = "fail";<a name="line.58"></a> |
| <span class="sourceLineNo">059</span><a name="line.59"></a> |
| <span class="sourceLineNo">060</span> /**<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> * The FIX policy indicates that if the checksum does not match the<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> * downloaded file, then fix the checksum file locally, and return<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> * to the client side the corrected checksum.<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> */<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> public static final String FIX = "fix";<a name="line.65"></a> |
| <span class="sourceLineNo">066</span><a name="line.66"></a> |
| <span class="sourceLineNo">067</span> private ChecksumAlgorithm[] algorithms = new ChecksumAlgorithm[]{ ChecksumAlgorithm.SHA1, ChecksumAlgorithm.MD5 };<a name="line.67"></a> |
| <span class="sourceLineNo">068</span><a name="line.68"></a> |
| <span class="sourceLineNo">069</span> private List<String> options = new ArrayList<>( 3 );<a name="line.69"></a> |
| <span class="sourceLineNo">070</span><a name="line.70"></a> |
| <span class="sourceLineNo">071</span> public ChecksumPolicy()<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> {<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> options.add( FAIL );<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> options.add( FIX );<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> options.add( IGNORE );<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> }<a name="line.76"></a> |
| <span class="sourceLineNo">077</span><a name="line.77"></a> |
| <span class="sourceLineNo">078</span> @Override<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> public void applyPolicy( String policySetting, Properties request, File localFile )<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> throws PolicyViolationException, PolicyConfigurationException<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> {<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> if ( "resource".equals( request.getProperty( "filetype" ) ) )<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> {<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> return;<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> }<a name="line.85"></a> |
| <span class="sourceLineNo">086</span><a name="line.86"></a> |
| <span class="sourceLineNo">087</span> if ( !options.contains( policySetting ) )<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> {<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> // Not a valid code. <a name="line.89"></a> |
| <span class="sourceLineNo">090</span> throw new PolicyConfigurationException(<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> "Unknown checksum policy setting [" + policySetting + "], valid settings are [" + StringUtils.join(<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> options.iterator(), "," ) + "]" );<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> }<a name="line.93"></a> |
| <span class="sourceLineNo">094</span><a name="line.94"></a> |
| <span class="sourceLineNo">095</span> if ( IGNORE.equals( policySetting ) )<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> {<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> // Ignore.<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> log.debug( "Checksum policy set to IGNORE." );<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> return;<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> }<a name="line.100"></a> |
| <span class="sourceLineNo">101</span><a name="line.101"></a> |
| <span class="sourceLineNo">102</span> if ( !localFile.exists() )<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> {<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> // Local File does not exist.<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> throw new PolicyViolationException(<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> "Checksum policy failure, local file " + localFile.getAbsolutePath() + " does not exist to check." );<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> }<a name="line.107"></a> |
| <span class="sourceLineNo">108</span><a name="line.108"></a> |
| <span class="sourceLineNo">109</span> if ( FAIL.equals( policySetting ) )<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> {<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> ChecksummedFile checksum = new ChecksummedFile( localFile );<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> if ( checksum.isValidChecksums( algorithms ) )<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> {<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> return;<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> }<a name="line.115"></a> |
| <span class="sourceLineNo">116</span><a name="line.116"></a> |
| <span class="sourceLineNo">117</span> for ( ChecksumAlgorithm algorithm : algorithms )<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> {<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> File file = new File( localFile.getAbsolutePath() + "." + algorithm.getExt() );<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> if ( file.exists() )<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> {<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> file.delete();<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> }<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> }<a name="line.124"></a> |
| <span class="sourceLineNo">125</span><a name="line.125"></a> |
| <span class="sourceLineNo">126</span> localFile.delete();<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> throw new PolicyViolationException(<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> "Checksums do not match, policy set to FAIL, " + "deleting checksum files and local file "<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> + localFile.getAbsolutePath() + "." );<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> }<a name="line.130"></a> |
| <span class="sourceLineNo">131</span><a name="line.131"></a> |
| <span class="sourceLineNo">132</span> if ( FIX.equals( policySetting ) )<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> {<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> ChecksummedFile checksum = new ChecksummedFile( localFile );<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> if ( checksum.fixChecksums( algorithms ) )<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> {<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> log.debug( "Checksum policy set to FIX, checksum files have been updated." );<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> return;<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> }<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> else<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> {<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> throw new PolicyViolationException(<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> "Checksum policy set to FIX, " + "yet unable to update checksums for local file "<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> + localFile.getAbsolutePath() + "." );<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> }<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> }<a name="line.146"></a> |
| <span class="sourceLineNo">147</span><a name="line.147"></a> |
| <span class="sourceLineNo">148</span> throw new PolicyConfigurationException(<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> "Unable to process checksum policy of [" + policySetting + "], please file a bug report." );<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> }<a name="line.150"></a> |
| <span class="sourceLineNo">151</span><a name="line.151"></a> |
| <span class="sourceLineNo">152</span> @Override<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> public String getDefaultOption()<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> {<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> return FIX;<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> }<a name="line.156"></a> |
| <span class="sourceLineNo">157</span><a name="line.157"></a> |
| <span class="sourceLineNo">158</span> @Override<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> public String getId()<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> {<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> return "checksum";<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> }<a name="line.162"></a> |
| <span class="sourceLineNo">163</span><a name="line.163"></a> |
| <span class="sourceLineNo">164</span> @Override<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> public String getName()<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> {<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> return "Checksum";<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> }<a name="line.168"></a> |
| <span class="sourceLineNo">169</span><a name="line.169"></a> |
| <span class="sourceLineNo">170</span> @Override<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> public List<String> getOptions()<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> {<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> return options;<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> }<a name="line.174"></a> |
| <span class="sourceLineNo">175</span>}<a name="line.175"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
