| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="de"> |
| <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.checksum;<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.common.utils.FileUtils;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.slf4j.Logger;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.slf4j.LoggerFactory;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span><a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import java.io.FileNotFoundException;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import java.io.IOException;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import java.nio.charset.Charset;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import java.nio.file.Files;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import java.nio.file.Path;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import java.nio.file.StandardOpenOption;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import java.util.ArrayList;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import java.util.Arrays;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>import java.util.List;<a name="line.34"></a> |
| <span class="sourceLineNo">035</span>import java.util.regex.Matcher;<a name="line.35"></a> |
| <span class="sourceLineNo">036</span>import java.util.regex.Pattern;<a name="line.36"></a> |
| <span class="sourceLineNo">037</span><a name="line.37"></a> |
| <span class="sourceLineNo">038</span>import static org.apache.archiva.checksum.ChecksumValidationException.ValidationError.BAD_CHECKSUM_FILE;<a name="line.38"></a> |
| <span class="sourceLineNo">039</span>import static org.apache.archiva.checksum.ChecksumValidationException.ValidationError.BAD_CHECKSUM_FILE_REF;<a name="line.39"></a> |
| <span class="sourceLineNo">040</span><a name="line.40"></a> |
| <span class="sourceLineNo">041</span>/**<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * ChecksummedFile<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * <p>Terminology:</p><a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * <dl><a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * <dt>Checksum File</dt><a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * <dd>The file that contains the previously calculated checksum value for the reference file.<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * This is a text file with the extension ".sha1" or ".md5", and contains a single entry<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * consisting of an optional reference filename, and a checksum string.<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * </dd><a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * <dt>Reference File</dt><a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * <dd>The file that is being referenced in the checksum file.</dd><a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * </dl><a name="line.52"></a> |
| <span class="sourceLineNo">053</span> */<a name="line.53"></a> |
| <span class="sourceLineNo">054</span>public class ChecksummedFile<a name="line.54"></a> |
| <span class="sourceLineNo">055</span>{<a name="line.55"></a> |
| <span class="sourceLineNo">056</span><a name="line.56"></a> |
| <span class="sourceLineNo">057</span> private static Charset FILE_ENCODING = Charset.forName( "UTF-8" );<a name="line.57"></a> |
| <span class="sourceLineNo">058</span><a name="line.58"></a> |
| <span class="sourceLineNo">059</span> private final Logger log = LoggerFactory.getLogger( ChecksummedFile.class );<a name="line.59"></a> |
| <span class="sourceLineNo">060</span><a name="line.60"></a> |
| <span class="sourceLineNo">061</span> private static final Pattern METADATA_PATTERN = Pattern.compile( "maven-metadata-\\S*.xml" );<a name="line.61"></a> |
| <span class="sourceLineNo">062</span><a name="line.62"></a> |
| <span class="sourceLineNo">063</span> private final Path referenceFile;<a name="line.63"></a> |
| <span class="sourceLineNo">064</span><a name="line.64"></a> |
| <span class="sourceLineNo">065</span> /**<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> * Construct a ChecksummedFile object.<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> *<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> * @param referenceFile<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> */<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> public ChecksummedFile( final Path referenceFile )<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> {<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> this.referenceFile = referenceFile;<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> }<a name="line.73"></a> |
| <span class="sourceLineNo">074</span><a name="line.74"></a> |
| <span class="sourceLineNo">075</span><a name="line.75"></a> |
| <span class="sourceLineNo">076</span> public static ChecksumReference getFromChecksumFile( Path checksumFile )<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> {<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> ChecksumAlgorithm alg = ChecksumAlgorithm.getByExtension( checksumFile );<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> ChecksummedFile file = new ChecksummedFile( getReferenceFile( checksumFile ) );<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> return new ChecksumReference( file, alg, checksumFile );<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> }<a name="line.81"></a> |
| <span class="sourceLineNo">082</span><a name="line.82"></a> |
| <span class="sourceLineNo">083</span> private static Path getReferenceFile( Path checksumFile )<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> {<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> String fileName = checksumFile.getFileName( ).toString( );<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> return checksumFile.resolveSibling( fileName.substring( 0, fileName.lastIndexOf( '.' ) ) );<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> }<a name="line.87"></a> |
| <span class="sourceLineNo">088</span><a name="line.88"></a> |
| <span class="sourceLineNo">089</span> /**<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> * Calculate the checksum based on a given checksum.<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> *<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> * @param checksumAlgorithm the algorithm to use.<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> * @return the checksum string for the file.<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> * @throws IOException if unable to calculate the checksum.<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> */<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> public String calculateChecksum( ChecksumAlgorithm checksumAlgorithm )<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> throws IOException<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> {<a name="line.98"></a> |
| <span class="sourceLineNo">099</span><a name="line.99"></a> |
| <span class="sourceLineNo">100</span> Checksum checksum = new Checksum( checksumAlgorithm );<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> ChecksumUtil.update(checksum, referenceFile );<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> return checksum.getChecksum( );<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> }<a name="line.103"></a> |
| <span class="sourceLineNo">104</span><a name="line.104"></a> |
| <span class="sourceLineNo">105</span> /**<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> * Writes a checksum file for the referenceFile.<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> *<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> * @param checksumAlgorithm the hash to use.<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> * @return the checksum File that was created.<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> * @throws IOException if there was a problem either reading the referenceFile, or writing the checksum file.<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> */<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> public Path writeFile(ChecksumAlgorithm checksumAlgorithm )<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> throws IOException<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> {<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> Path checksumFile = referenceFile.resolveSibling( referenceFile.getFileName( ) + "." + checksumAlgorithm.getDefaultExtension() );<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> Files.deleteIfExists( checksumFile );<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> String checksum = calculateChecksum( checksumAlgorithm );<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> Files.write( checksumFile, //<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> ( checksum + " " + referenceFile.getFileName( ).toString( ) ).getBytes( ), //<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> StandardOpenOption.CREATE_NEW );<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> return checksumFile;<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> }<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> * Get the checksum file for the reference file and hash.<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> * It returns a file for the given checksum, if one exists with one of the possible extensions.<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> * If it does not exist, a default path will be returned.<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> *<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> * @param checksumAlgorithm the hash that we are interested in.<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> * @return the checksum file to return<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> */<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> public Path getChecksumFile( ChecksumAlgorithm checksumAlgorithm )<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> {<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> for ( String ext : checksumAlgorithm.getExt( ) )<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> {<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> Path file = referenceFile.resolveSibling( referenceFile.getFileName( ) + "." + checksumAlgorithm.getExt( ) );<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> if ( Files.exists( file ) )<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> {<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> return file;<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> }<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> }<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> return referenceFile.resolveSibling( referenceFile.getFileName( ) + "." + checksumAlgorithm.getDefaultExtension() );<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> }<a name="line.143"></a> |
| <span class="sourceLineNo">144</span><a name="line.144"></a> |
| <span class="sourceLineNo">145</span> /**<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> * <p><a name="line.146"></a> |
| <span class="sourceLineNo">147</span> * Given a checksum file, check to see if the file it represents is valid according to the checksum.<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> * </p><a name="line.148"></a> |
| <span class="sourceLineNo">149</span> * <p><a name="line.149"></a> |
| <span class="sourceLineNo">150</span> * NOTE: Only supports single file checksums of type MD5 or SHA1.<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> * </p><a name="line.151"></a> |
| <span class="sourceLineNo">152</span> *<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> * @param algorithm the algorithms to check for.<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> * @return true if the checksum is valid for the file it represents. or if the checksum file does not exist.<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> * @throws IOException if the reading of the checksumFile or the file it refers to fails.<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> */<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> public boolean isValidChecksum( ChecksumAlgorithm algorithm) throws ChecksumValidationException<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> {<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> return isValidChecksum( algorithm, false );<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> }<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> public boolean isValidChecksum( ChecksumAlgorithm algorithm, boolean throwExceptions )<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> throws ChecksumValidationException<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> {<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> return isValidChecksums( Arrays.asList( algorithm ), throwExceptions );<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> }<a name="line.165"></a> |
| <span class="sourceLineNo">166</span><a name="line.166"></a> |
| <span class="sourceLineNo">167</span> /**<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> * Of any checksum files present, validate that the reference file conforms<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> * the to the checksum.<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> *<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> * @param algorithms the algorithms to check for.<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> * @return true if the checksums report that the the reference file is valid, false if invalid.<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> */<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> public boolean isValidChecksums( List<ChecksumAlgorithm> algorithms) throws ChecksumValidationException<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> {<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> return isValidChecksums( algorithms, false );<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> }<a name="line.177"></a> |
| <span class="sourceLineNo">178</span><a name="line.178"></a> |
| <span class="sourceLineNo">179</span> /**<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> * Checks if the checksum files are valid for the referenced file.<a name="line.180"></a> |
| <span class="sourceLineNo">181</span> * It tries to find a checksum file for each algorithm in the same directory as the referenceFile.<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> * The method returns true, if at least one checksum file exists for one of the given algorithms<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> * and all existing checksum files are valid.<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> *<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> * This method throws only exceptions, if throwExceptions is true. Otherwise false will be returned instead.<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> *<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> * It verifies only the existing checksum files. If the checksum file for a particular algorithm does not exist,<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> * but others exist and are valid, it will return true.<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> *<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> * @param algorithms The algorithms to verify<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> * @param throwExceptions If true, exceptions will be thrown, otherwise false will be returned, if a exception occurred.<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> * @return True, if it is valid for all existing checksum files, otherwise false.<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> * @throws ChecksumValidationException<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> */<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> public boolean isValidChecksums( List<ChecksumAlgorithm> algorithms, boolean throwExceptions) throws ChecksumValidationException<a name="line.195"></a> |
| <span class="sourceLineNo">196</span> {<a name="line.196"></a> |
| <span class="sourceLineNo">197</span><a name="line.197"></a> |
| <span class="sourceLineNo">198</span> List<Checksum> checksums;<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> // Parse file once, for all checksums.<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> try<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> {<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> checksums = ChecksumUtil.initializeChecksums( referenceFile, algorithms );<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> }<a name="line.203"></a> |
| <span class="sourceLineNo">204</span> catch (IOException e )<a name="line.204"></a> |
| <span class="sourceLineNo">205</span> {<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> log.warn( "Unable to update checksum:{}", e.getMessage( ) );<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> if (throwExceptions) {<a name="line.207"></a> |
| <span class="sourceLineNo">208</span> if (e instanceof FileNotFoundException) {<a name="line.208"></a> |
| <span class="sourceLineNo">209</span> throw new ChecksumValidationException(ChecksumValidationException.ValidationError.FILE_NOT_FOUND, e);<a name="line.209"></a> |
| <span class="sourceLineNo">210</span> } else {<a name="line.210"></a> |
| <span class="sourceLineNo">211</span> throw new ChecksumValidationException(ChecksumValidationException.ValidationError.READ_ERROR, e);<a name="line.211"></a> |
| <span class="sourceLineNo">212</span> }<a name="line.212"></a> |
| <span class="sourceLineNo">213</span> } else {<a name="line.213"></a> |
| <span class="sourceLineNo">214</span> return false;<a name="line.214"></a> |
| <span class="sourceLineNo">215</span> }<a name="line.215"></a> |
| <span class="sourceLineNo">216</span> }<a name="line.216"></a> |
| <span class="sourceLineNo">217</span><a name="line.217"></a> |
| <span class="sourceLineNo">218</span> boolean valid = true;<a name="line.218"></a> |
| <span class="sourceLineNo">219</span> boolean fileExists = false;<a name="line.219"></a> |
| <span class="sourceLineNo">220</span><a name="line.220"></a> |
| <span class="sourceLineNo">221</span> // No file exists -> return false<a name="line.221"></a> |
| <span class="sourceLineNo">222</span> // if at least one file exists:<a name="line.222"></a> |
| <span class="sourceLineNo">223</span> // -> all existing files must be valid<a name="line.223"></a> |
| <span class="sourceLineNo">224</span><a name="line.224"></a> |
| <span class="sourceLineNo">225</span> // check the checksum files<a name="line.225"></a> |
| <span class="sourceLineNo">226</span> try<a name="line.226"></a> |
| <span class="sourceLineNo">227</span> {<a name="line.227"></a> |
| <span class="sourceLineNo">228</span><a name="line.228"></a> |
| <span class="sourceLineNo">229</span> for ( Checksum checksum : checksums )<a name="line.229"></a> |
| <span class="sourceLineNo">230</span> {<a name="line.230"></a> |
| <span class="sourceLineNo">231</span> ChecksumAlgorithm checksumAlgorithm = checksum.getAlgorithm( );<a name="line.231"></a> |
| <span class="sourceLineNo">232</span> Path checksumFile = getChecksumFile( checksumAlgorithm );<a name="line.232"></a> |
| <span class="sourceLineNo">233</span><a name="line.233"></a> |
| <span class="sourceLineNo">234</span> if (Files.exists(checksumFile)) {<a name="line.234"></a> |
| <span class="sourceLineNo">235</span> fileExists = true;<a name="line.235"></a> |
| <span class="sourceLineNo">236</span> String expectedChecksum = parseChecksum(checksumFile, checksumAlgorithm, referenceFile.getFileName().toString(), FILE_ENCODING);<a name="line.236"></a> |
| <span class="sourceLineNo">237</span><a name="line.237"></a> |
| <span class="sourceLineNo">238</span> valid &= checksum.compare(expectedChecksum);<a name="line.238"></a> |
| <span class="sourceLineNo">239</span> }<a name="line.239"></a> |
| <span class="sourceLineNo">240</span> }<a name="line.240"></a> |
| <span class="sourceLineNo">241</span> }<a name="line.241"></a> |
| <span class="sourceLineNo">242</span> catch ( ChecksumValidationException e )<a name="line.242"></a> |
| <span class="sourceLineNo">243</span> {<a name="line.243"></a> |
| <span class="sourceLineNo">244</span> log.warn( "Unable to read / parse checksum: {}", e.getMessage( ) );<a name="line.244"></a> |
| <span class="sourceLineNo">245</span> if (throwExceptions) {<a name="line.245"></a> |
| <span class="sourceLineNo">246</span> throw e;<a name="line.246"></a> |
| <span class="sourceLineNo">247</span> } else<a name="line.247"></a> |
| <span class="sourceLineNo">248</span> {<a name="line.248"></a> |
| <span class="sourceLineNo">249</span> return false;<a name="line.249"></a> |
| <span class="sourceLineNo">250</span> }<a name="line.250"></a> |
| <span class="sourceLineNo">251</span> }<a name="line.251"></a> |
| <span class="sourceLineNo">252</span><a name="line.252"></a> |
| <span class="sourceLineNo">253</span> return fileExists && valid;<a name="line.253"></a> |
| <span class="sourceLineNo">254</span> }<a name="line.254"></a> |
| <span class="sourceLineNo">255</span><a name="line.255"></a> |
| <span class="sourceLineNo">256</span> public Path getReferenceFile( )<a name="line.256"></a> |
| <span class="sourceLineNo">257</span> {<a name="line.257"></a> |
| <span class="sourceLineNo">258</span> return referenceFile;<a name="line.258"></a> |
| <span class="sourceLineNo">259</span> }<a name="line.259"></a> |
| <span class="sourceLineNo">260</span><a name="line.260"></a> |
| <span class="sourceLineNo">261</span><a name="line.261"></a> |
| <span class="sourceLineNo">262</span><a name="line.262"></a> |
| <span class="sourceLineNo">263</span> public UpdateStatusList fixChecksum(ChecksumAlgorithm algorithm) {<a name="line.263"></a> |
| <span class="sourceLineNo">264</span> return fixChecksums( Arrays.asList(algorithm) );<a name="line.264"></a> |
| <span class="sourceLineNo">265</span> }<a name="line.265"></a> |
| <span class="sourceLineNo">266</span><a name="line.266"></a> |
| <span class="sourceLineNo">267</span> /**<a name="line.267"></a> |
| <span class="sourceLineNo">268</span> * Writes a checksum file, if it does not exist or if it exists and has a different<a name="line.268"></a> |
| <span class="sourceLineNo">269</span> * checksum value.<a name="line.269"></a> |
| <span class="sourceLineNo">270</span> *<a name="line.270"></a> |
| <span class="sourceLineNo">271</span> * @param algorithms the hashes to check for.<a name="line.271"></a> |
| <span class="sourceLineNo">272</span> * @return true if checksums were created successfully.<a name="line.272"></a> |
| <span class="sourceLineNo">273</span> */<a name="line.273"></a> |
| <span class="sourceLineNo">274</span> public UpdateStatusList fixChecksums( List<ChecksumAlgorithm> algorithms )<a name="line.274"></a> |
| <span class="sourceLineNo">275</span> {<a name="line.275"></a> |
| <span class="sourceLineNo">276</span> UpdateStatusList result = UpdateStatusList.INITIALIZE(algorithms);<a name="line.276"></a> |
| <span class="sourceLineNo">277</span> List<Checksum> checksums;<a name="line.277"></a> |
| <span class="sourceLineNo">278</span><a name="line.278"></a> |
| <span class="sourceLineNo">279</span><a name="line.279"></a> |
| <span class="sourceLineNo">280</span> try<a name="line.280"></a> |
| <span class="sourceLineNo">281</span> {<a name="line.281"></a> |
| <span class="sourceLineNo">282</span> // Parse file once, for all checksums.<a name="line.282"></a> |
| <span class="sourceLineNo">283</span> checksums = ChecksumUtil.initializeChecksums(getReferenceFile(), algorithms);<a name="line.283"></a> |
| <span class="sourceLineNo">284</span> }<a name="line.284"></a> |
| <span class="sourceLineNo">285</span> catch (IOException e )<a name="line.285"></a> |
| <span class="sourceLineNo">286</span> {<a name="line.286"></a> |
| <span class="sourceLineNo">287</span> log.warn( e.getMessage( ), e );<a name="line.287"></a> |
| <span class="sourceLineNo">288</span> result.setTotalError(e);<a name="line.288"></a> |
| <span class="sourceLineNo">289</span> return result;<a name="line.289"></a> |
| <span class="sourceLineNo">290</span> }<a name="line.290"></a> |
| <span class="sourceLineNo">291</span> // Any checksums?<a name="line.291"></a> |
| <span class="sourceLineNo">292</span> if ( checksums.isEmpty( ) )<a name="line.292"></a> |
| <span class="sourceLineNo">293</span> {<a name="line.293"></a> |
| <span class="sourceLineNo">294</span> // No checksum objects, no checksum files, default to is valid.<a name="line.294"></a> |
| <span class="sourceLineNo">295</span> return result;<a name="line.295"></a> |
| <span class="sourceLineNo">296</span> }<a name="line.296"></a> |
| <span class="sourceLineNo">297</span><a name="line.297"></a> |
| <span class="sourceLineNo">298</span> boolean valid = true;<a name="line.298"></a> |
| <span class="sourceLineNo">299</span><a name="line.299"></a> |
| <span class="sourceLineNo">300</span> // check the hash files<a name="line.300"></a> |
| <span class="sourceLineNo">301</span> for ( Checksum checksum : checksums )<a name="line.301"></a> |
| <span class="sourceLineNo">302</span> {<a name="line.302"></a> |
| <span class="sourceLineNo">303</span> ChecksumAlgorithm checksumAlgorithm = checksum.getAlgorithm( );<a name="line.303"></a> |
| <span class="sourceLineNo">304</span> try<a name="line.304"></a> |
| <span class="sourceLineNo">305</span> {<a name="line.305"></a> |
| <span class="sourceLineNo">306</span> Path checksumFile = getChecksumFile( checksumAlgorithm );<a name="line.306"></a> |
| <span class="sourceLineNo">307</span> if ( Files.exists( checksumFile ) )<a name="line.307"></a> |
| <span class="sourceLineNo">308</span> {<a name="line.308"></a> |
| <span class="sourceLineNo">309</span> String expectedChecksum;<a name="line.309"></a> |
| <span class="sourceLineNo">310</span> try<a name="line.310"></a> |
| <span class="sourceLineNo">311</span> {<a name="line.311"></a> |
| <span class="sourceLineNo">312</span> expectedChecksum = parseChecksum( checksumFile, checksumAlgorithm, referenceFile.getFileName( ).toString( ), FILE_ENCODING );<a name="line.312"></a> |
| <span class="sourceLineNo">313</span> } catch (ChecksumValidationException ex) {<a name="line.313"></a> |
| <span class="sourceLineNo">314</span> expectedChecksum = "";<a name="line.314"></a> |
| <span class="sourceLineNo">315</span> }<a name="line.315"></a> |
| <span class="sourceLineNo">316</span><a name="line.316"></a> |
| <span class="sourceLineNo">317</span> if ( !checksum.compare( expectedChecksum ) )<a name="line.317"></a> |
| <span class="sourceLineNo">318</span> {<a name="line.318"></a> |
| <span class="sourceLineNo">319</span> // overwrite checksum file<a name="line.319"></a> |
| <span class="sourceLineNo">320</span> writeChecksumFile( checksumFile, FILE_ENCODING, checksum.getChecksum( ) );<a name="line.320"></a> |
| <span class="sourceLineNo">321</span> result.setStatus(checksumAlgorithm,UpdateStatus.UPDATED);<a name="line.321"></a> |
| <span class="sourceLineNo">322</span> }<a name="line.322"></a> |
| <span class="sourceLineNo">323</span> }<a name="line.323"></a> |
| <span class="sourceLineNo">324</span> else<a name="line.324"></a> |
| <span class="sourceLineNo">325</span> {<a name="line.325"></a> |
| <span class="sourceLineNo">326</span> writeChecksumFile( checksumFile, FILE_ENCODING, checksum.getChecksum( ) );<a name="line.326"></a> |
| <span class="sourceLineNo">327</span> result.setStatus(checksumAlgorithm, UpdateStatus.CREATED);<a name="line.327"></a> |
| <span class="sourceLineNo">328</span> }<a name="line.328"></a> |
| <span class="sourceLineNo">329</span> }<a name="line.329"></a> |
| <span class="sourceLineNo">330</span> catch ( ChecksumValidationException e )<a name="line.330"></a> |
| <span class="sourceLineNo">331</span> {<a name="line.331"></a> |
| <span class="sourceLineNo">332</span> log.warn( e.getMessage( ), e );<a name="line.332"></a> |
| <span class="sourceLineNo">333</span> result.setErrorStatus(checksumAlgorithm, e);<a name="line.333"></a> |
| <span class="sourceLineNo">334</span> }<a name="line.334"></a> |
| <span class="sourceLineNo">335</span> }<a name="line.335"></a> |
| <span class="sourceLineNo">336</span><a name="line.336"></a> |
| <span class="sourceLineNo">337</span> return result;<a name="line.337"></a> |
| <span class="sourceLineNo">338</span><a name="line.338"></a> |
| <span class="sourceLineNo">339</span> }<a name="line.339"></a> |
| <span class="sourceLineNo">340</span><a name="line.340"></a> |
| <span class="sourceLineNo">341</span> private void writeChecksumFile( Path checksumFile, Charset encoding, String checksumHex )<a name="line.341"></a> |
| <span class="sourceLineNo">342</span> {<a name="line.342"></a> |
| <span class="sourceLineNo">343</span> FileUtils.writeStringToFile( checksumFile, FILE_ENCODING, checksumHex + " " + referenceFile.getFileName( ).toString( ) );<a name="line.343"></a> |
| <span class="sourceLineNo">344</span> }<a name="line.344"></a> |
| <span class="sourceLineNo">345</span><a name="line.345"></a> |
| <span class="sourceLineNo">346</span> private boolean isValidChecksumPattern( String filename, String path )<a name="line.346"></a> |
| <span class="sourceLineNo">347</span> {<a name="line.347"></a> |
| <span class="sourceLineNo">348</span> // check if it is a remote metadata file<a name="line.348"></a> |
| <span class="sourceLineNo">349</span><a name="line.349"></a> |
| <span class="sourceLineNo">350</span> Matcher m = METADATA_PATTERN.matcher( path );<a name="line.350"></a> |
| <span class="sourceLineNo">351</span> if ( m.matches( ) )<a name="line.351"></a> |
| <span class="sourceLineNo">352</span> {<a name="line.352"></a> |
| <span class="sourceLineNo">353</span> return filename.endsWith( path ) || ( "-".equals( filename ) ) || filename.endsWith( "maven-metadata.xml" );<a name="line.353"></a> |
| <span class="sourceLineNo">354</span> }<a name="line.354"></a> |
| <span class="sourceLineNo">355</span><a name="line.355"></a> |
| <span class="sourceLineNo">356</span> return filename.endsWith( path ) || ( "-".equals( filename ) );<a name="line.356"></a> |
| <span class="sourceLineNo">357</span> }<a name="line.357"></a> |
| <span class="sourceLineNo">358</span><a name="line.358"></a> |
| <span class="sourceLineNo">359</span> /**<a name="line.359"></a> |
| <span class="sourceLineNo">360</span> * Parse a checksum string.<a name="line.360"></a> |
| <span class="sourceLineNo">361</span> * <p><a name="line.361"></a> |
| <span class="sourceLineNo">362</span> * Validate the expected path, and expected checksum algorithm, then return<a name="line.362"></a> |
| <span class="sourceLineNo">363</span> * the trimmed checksum hex string.<a name="line.363"></a> |
| <span class="sourceLineNo">364</span> * </p><a name="line.364"></a> |
| <span class="sourceLineNo">365</span> *<a name="line.365"></a> |
| <span class="sourceLineNo">366</span> * @param checksumFile The file where the checksum is stored<a name="line.366"></a> |
| <span class="sourceLineNo">367</span> * @param checksumAlgorithm The checksum algorithm to check<a name="line.367"></a> |
| <span class="sourceLineNo">368</span> * @param fileName The filename of the reference file<a name="line.368"></a> |
| <span class="sourceLineNo">369</span> * @return<a name="line.369"></a> |
| <span class="sourceLineNo">370</span> * @throws IOException<a name="line.370"></a> |
| <span class="sourceLineNo">371</span> */<a name="line.371"></a> |
| <span class="sourceLineNo">372</span> public String parseChecksum( Path checksumFile, ChecksumAlgorithm checksumAlgorithm, String fileName, Charset encoding )<a name="line.372"></a> |
| <span class="sourceLineNo">373</span> throws ChecksumValidationException<a name="line.373"></a> |
| <span class="sourceLineNo">374</span> {<a name="line.374"></a> |
| <span class="sourceLineNo">375</span> ChecksumFileContent fc = parseChecksumFile( checksumFile, checksumAlgorithm, encoding );<a name="line.375"></a> |
| <span class="sourceLineNo">376</span> if ( fc.isFormatMatch() && !isValidChecksumPattern( fc.getFileReference( ), fileName ) )<a name="line.376"></a> |
| <span class="sourceLineNo">377</span> {<a name="line.377"></a> |
| <span class="sourceLineNo">378</span> throw new ChecksumValidationException(BAD_CHECKSUM_FILE_REF,<a name="line.378"></a> |
| <span class="sourceLineNo">379</span> "The file reference '" + fc.getFileReference( ) + "' in the checksum file does not match expected file: '" + fileName + "'" );<a name="line.379"></a> |
| <span class="sourceLineNo">380</span> } else if (!fc.isFormatMatch()) {<a name="line.380"></a> |
| <span class="sourceLineNo">381</span> throw new ChecksumValidationException( BAD_CHECKSUM_FILE, "The checksum file content could not be parsed: "+checksumFile );<a name="line.381"></a> |
| <span class="sourceLineNo">382</span> }<a name="line.382"></a> |
| <span class="sourceLineNo">383</span> return fc.getChecksum( );<a name="line.383"></a> |
| <span class="sourceLineNo">384</span><a name="line.384"></a> |
| <span class="sourceLineNo">385</span> }<a name="line.385"></a> |
| <span class="sourceLineNo">386</span> public ChecksumFileContent parseChecksumFile( Path checksumFile, ChecksumAlgorithm checksumAlgorithm, Charset encoding )<a name="line.386"></a> |
| <span class="sourceLineNo">387</span> {<a name="line.387"></a> |
| <span class="sourceLineNo">388</span> ChecksumFileContent fc = new ChecksumFileContent( );<a name="line.388"></a> |
| <span class="sourceLineNo">389</span> String rawChecksumString = FileUtils.readFileToString( checksumFile, encoding );<a name="line.389"></a> |
| <span class="sourceLineNo">390</span> String trimmedChecksum = rawChecksumString.replace( '\n', ' ' ).trim( );<a name="line.390"></a> |
| <span class="sourceLineNo">391</span><a name="line.391"></a> |
| <span class="sourceLineNo">392</span> // Free-BSD / openssl<a name="line.392"></a> |
| <span class="sourceLineNo">393</span> String regex = checksumAlgorithm.getType( ) + "\\s*\\(([^)]*)\\)\\s*=\\s*([a-fA-F0-9]+)";<a name="line.393"></a> |
| <span class="sourceLineNo">394</span> Matcher m = Pattern.compile( regex ).matcher( trimmedChecksum );<a name="line.394"></a> |
| <span class="sourceLineNo">395</span> if ( m.matches( ) )<a name="line.395"></a> |
| <span class="sourceLineNo">396</span> {<a name="line.396"></a> |
| <span class="sourceLineNo">397</span> fc.setFileReference( m.group( 1 ) );<a name="line.397"></a> |
| <span class="sourceLineNo">398</span> fc.setChecksum( m.group( 2 ) );<a name="line.398"></a> |
| <span class="sourceLineNo">399</span> fc.setFormatMatch( true );<a name="line.399"></a> |
| <span class="sourceLineNo">400</span> }<a name="line.400"></a> |
| <span class="sourceLineNo">401</span> else<a name="line.401"></a> |
| <span class="sourceLineNo">402</span> {<a name="line.402"></a> |
| <span class="sourceLineNo">403</span> // GNU tools<a name="line.403"></a> |
| <span class="sourceLineNo">404</span> m = Pattern.compile( "([a-fA-F0-9]+)\\s+\\*?(.+)" ).matcher( trimmedChecksum );<a name="line.404"></a> |
| <span class="sourceLineNo">405</span> if ( m.matches( ) )<a name="line.405"></a> |
| <span class="sourceLineNo">406</span> {<a name="line.406"></a> |
| <span class="sourceLineNo">407</span> fc.setFileReference( m.group( 2 ) );<a name="line.407"></a> |
| <span class="sourceLineNo">408</span> fc.setChecksum( m.group( 1 ) );<a name="line.408"></a> |
| <span class="sourceLineNo">409</span> fc.setFormatMatch( true );<a name="line.409"></a> |
| <span class="sourceLineNo">410</span> }<a name="line.410"></a> |
| <span class="sourceLineNo">411</span> else<a name="line.411"></a> |
| <span class="sourceLineNo">412</span> {<a name="line.412"></a> |
| <span class="sourceLineNo">413</span> fc.setFileReference( "" );<a name="line.413"></a> |
| <span class="sourceLineNo">414</span> fc.setChecksum( trimmedChecksum );<a name="line.414"></a> |
| <span class="sourceLineNo">415</span> fc.setFormatMatch( false );<a name="line.415"></a> |
| <span class="sourceLineNo">416</span> }<a name="line.416"></a> |
| <span class="sourceLineNo">417</span> }<a name="line.417"></a> |
| <span class="sourceLineNo">418</span> return fc;<a name="line.418"></a> |
| <span class="sourceLineNo">419</span> }<a name="line.419"></a> |
| <span class="sourceLineNo">420</span>}<a name="line.420"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
