blob: 3d0288d7af7b2a196ce18fbe0f2f68b66803994f [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head><meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>ChecksummedFile xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../apidocs/org/apache/archiva/checksum/ChecksummedFile.html">View Javadoc</a></div><pre>
<a class="jxr_linenumber" name="L1" href="#L1">1</a> <strong class="jxr_keyword">package</strong> org.apache.archiva.checksum;
<a class="jxr_linenumber" name="L2" href="#L2">2</a>
<a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em>
<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * distributed with this work for additional information</em>
<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em>
<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em>
<a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em>
<a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em>
<a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2." target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.</a>0</em>
<a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em>
<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em>
<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
<a class="jxr_linenumber" name="L17" href="#L17">17</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em>
<a class="jxr_linenumber" name="L18" href="#L18">18</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em>
<a class="jxr_linenumber" name="L19" href="#L19">19</a> <em class="jxr_comment"> * under the License.</em>
<a class="jxr_linenumber" name="L20" href="#L20">20</a> <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="L21" href="#L21">21</a>
<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> org.apache.commons.io.FileUtils;
<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> org.apache.commons.lang.StringUtils;
<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> org.slf4j.Logger;
<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory;
<a class="jxr_linenumber" name="L26" href="#L26">26</a>
<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> java.io.File;
<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> java.io.IOException;
<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> java.io.InputStream;
<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> java.nio.file.Files;
<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> java.nio.file.StandardOpenOption;
<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> java.util.ArrayList;
<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> java.util.List;
<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> java.util.regex.Matcher;
<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> java.util.regex.Pattern;
<a class="jxr_linenumber" name="L36" href="#L36">36</a>
<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment"> * ChecksummedFile</em>
<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment"> * &lt;p&gt;Terminology:&lt;/p&gt;</em>
<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> * &lt;dl&gt;</em>
<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> * &lt;dt&gt;Checksum File&lt;/dt&gt;</em>
<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> * &lt;dd&gt;The file that contains the previously calculated checksum value for the reference file.</em>
<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> * This is a text file with the extension ".sha1" or ".md5", and contains a single entry</em>
<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> * consisting of an optional reference filename, and a checksum string.</em>
<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> * &lt;/dd&gt;</em>
<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> * &lt;dt&gt;Reference File&lt;/dt&gt;</em>
<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> * &lt;dd&gt;The file that is being referenced in the checksum file.&lt;/dd&gt;</em>
<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> * &lt;/dl&gt;</em>
<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L50" href="#L50">50</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/apache/archiva/checksum/ChecksummedFile.html">ChecksummedFile</a>
<a class="jxr_linenumber" name="L51" href="#L51">51</a> {
<a class="jxr_linenumber" name="L52" href="#L52">52</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> Logger log = LoggerFactory.getLogger( ChecksummedFile.<strong class="jxr_keyword">class</strong> );
<a class="jxr_linenumber" name="L53" href="#L53">53</a>
<a class="jxr_linenumber" name="L54" href="#L54">54</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Pattern METADATA_PATTERN = Pattern.compile( <span class="jxr_string">"maven-metadata-&#92;&#92;S*.xml"</span> );
<a class="jxr_linenumber" name="L55" href="#L55">55</a>
<a class="jxr_linenumber" name="L56" href="#L56">56</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> File referenceFile;
<a class="jxr_linenumber" name="L57" href="#L57">57</a>
<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> * Construct a ChecksummedFile object.</em>
<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> * @param referenceFile</em>
<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L63" href="#L63">63</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/archiva/checksum/ChecksummedFile.html">ChecksummedFile</a>( <strong class="jxr_keyword">final</strong> File referenceFile )
<a class="jxr_linenumber" name="L64" href="#L64">64</a> {
<a class="jxr_linenumber" name="L65" href="#L65">65</a> <strong class="jxr_keyword">this</strong>.referenceFile = referenceFile;
<a class="jxr_linenumber" name="L66" href="#L66">66</a> }
<a class="jxr_linenumber" name="L67" href="#L67">67</a>
<a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment"> * Calculate the checksum based on a given checksum.</em>
<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment"> * @param checksumAlgorithm the algorithm to use.</em>
<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> * @return the checksum string for the file.</em>
<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> * @throws IOException if unable to calculate the checksum.</em>
<a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L75" href="#L75">75</a> <strong class="jxr_keyword">public</strong> String calculateChecksum( ChecksumAlgorithm checksumAlgorithm )
<a class="jxr_linenumber" name="L76" href="#L76">76</a> <strong class="jxr_keyword">throws</strong> IOException
<a class="jxr_linenumber" name="L77" href="#L77">77</a> {
<a class="jxr_linenumber" name="L78" href="#L78">78</a>
<a class="jxr_linenumber" name="L79" href="#L79">79</a> <strong class="jxr_keyword">try</strong> (InputStream fis = Files.newInputStream( referenceFile.toPath() ))
<a class="jxr_linenumber" name="L80" href="#L80">80</a> {
<a class="jxr_linenumber" name="L81" href="#L81">81</a> <a href="../../../../org/apache/archiva/checksum/Checksum.html">Checksum</a> checksum = <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/archiva/checksum/Checksum.html">Checksum</a>( checksumAlgorithm );
<a class="jxr_linenumber" name="L82" href="#L82">82</a> checksum.update( fis );
<a class="jxr_linenumber" name="L83" href="#L83">83</a> <strong class="jxr_keyword">return</strong> checksum.getChecksum();
<a class="jxr_linenumber" name="L84" href="#L84">84</a> }
<a class="jxr_linenumber" name="L85" href="#L85">85</a> }
<a class="jxr_linenumber" name="L86" href="#L86">86</a>
<a class="jxr_linenumber" name="L87" href="#L87">87</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_javadoccomment"> * Creates a checksum file of the provided referenceFile.</em>
<a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L90" href="#L90">90</a> <em class="jxr_javadoccomment"> * @param checksumAlgorithm the hash to use.</em>
<a class="jxr_linenumber" name="L91" href="#L91">91</a> <em class="jxr_javadoccomment"> * @return the checksum File that was created.</em>
<a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment"> * @throws IOException if there was a problem either reading the referenceFile, or writing the checksum file.</em>
<a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L94" href="#L94">94</a> <strong class="jxr_keyword">public</strong> File createChecksum( ChecksumAlgorithm checksumAlgorithm )
<a class="jxr_linenumber" name="L95" href="#L95">95</a> <strong class="jxr_keyword">throws</strong> IOException
<a class="jxr_linenumber" name="L96" href="#L96">96</a> {
<a class="jxr_linenumber" name="L97" href="#L97">97</a> File checksumFile = <strong class="jxr_keyword">new</strong> File( referenceFile.getAbsolutePath() + <span class="jxr_string">"."</span> + checksumAlgorithm.getExt() );
<a class="jxr_linenumber" name="L98" href="#L98">98</a> Files.deleteIfExists( checksumFile.toPath() );
<a class="jxr_linenumber" name="L99" href="#L99">99</a> String checksum = calculateChecksum( checksumAlgorithm );
<a class="jxr_linenumber" name="L100" href="#L100">100</a> Files.write( checksumFile.toPath(), <em class="jxr_comment">//</em>
<a class="jxr_linenumber" name="L101" href="#L101">101</a> ( checksum + <span class="jxr_string">" "</span> + referenceFile.getName() ).getBytes(), <em class="jxr_comment">//</em>
<a class="jxr_linenumber" name="L102" href="#L102">102</a> StandardOpenOption.CREATE_NEW );
<a class="jxr_linenumber" name="L103" href="#L103">103</a> <strong class="jxr_keyword">return</strong> checksumFile;
<a class="jxr_linenumber" name="L104" href="#L104">104</a> }
<a class="jxr_linenumber" name="L105" href="#L105">105</a>
<a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment"> * Get the checksum file for the reference file and hash.</em>
<a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L109" href="#L109">109</a> <em class="jxr_javadoccomment"> * @param checksumAlgorithm the hash that we are interested in.</em>
<a class="jxr_linenumber" name="L110" href="#L110">110</a> <em class="jxr_javadoccomment"> * @return the checksum file to return</em>
<a class="jxr_linenumber" name="L111" href="#L111">111</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L112" href="#L112">112</a> <strong class="jxr_keyword">public</strong> File getChecksumFile( ChecksumAlgorithm checksumAlgorithm )
<a class="jxr_linenumber" name="L113" href="#L113">113</a> {
<a class="jxr_linenumber" name="L114" href="#L114">114</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> File( referenceFile.getAbsolutePath() + <span class="jxr_string">"."</span> + checksumAlgorithm.getExt() );
<a class="jxr_linenumber" name="L115" href="#L115">115</a> }
<a class="jxr_linenumber" name="L116" href="#L116">116</a>
<a class="jxr_linenumber" name="L117" href="#L117">117</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L118" href="#L118">118</a> <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a class="jxr_linenumber" name="L119" href="#L119">119</a> <em class="jxr_javadoccomment"> * Given a checksum file, check to see if the file it represents is valid according to the checksum.</em>
<a class="jxr_linenumber" name="L120" href="#L120">120</a> <em class="jxr_javadoccomment"> * &lt;/p&gt;</em>
<a class="jxr_linenumber" name="L121" href="#L121">121</a> <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a class="jxr_linenumber" name="L122" href="#L122">122</a> <em class="jxr_javadoccomment"> * NOTE: Only supports single file checksums of type MD5 or SHA1.</em>
<a class="jxr_linenumber" name="L123" href="#L123">123</a> <em class="jxr_javadoccomment"> * &lt;/p&gt;</em>
<a class="jxr_linenumber" name="L124" href="#L124">124</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L125" href="#L125">125</a> <em class="jxr_javadoccomment"> * @param algorithm the algorithms to check for.</em>
<a class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_javadoccomment"> * @return true if the checksum is valid for the file it represents. or if the checksum file does not exist.</em>
<a class="jxr_linenumber" name="L127" href="#L127">127</a> <em class="jxr_javadoccomment"> * @throws IOException if the reading of the checksumFile or the file it refers to fails.</em>
<a class="jxr_linenumber" name="L128" href="#L128">128</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L129" href="#L129">129</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isValidChecksum( ChecksumAlgorithm algorithm )
<a class="jxr_linenumber" name="L130" href="#L130">130</a> <strong class="jxr_keyword">throws</strong> IOException
<a class="jxr_linenumber" name="L131" href="#L131">131</a> {
<a class="jxr_linenumber" name="L132" href="#L132">132</a> <strong class="jxr_keyword">return</strong> isValidChecksums( <strong class="jxr_keyword">new</strong> ChecksumAlgorithm[]{ algorithm } );
<a class="jxr_linenumber" name="L133" href="#L133">133</a> }
<a class="jxr_linenumber" name="L134" href="#L134">134</a>
<a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L136" href="#L136">136</a> <em class="jxr_javadoccomment"> * Of any checksum files present, validate that the reference file conforms</em>
<a class="jxr_linenumber" name="L137" href="#L137">137</a> <em class="jxr_javadoccomment"> * the to the checksum.</em>
<a class="jxr_linenumber" name="L138" href="#L138">138</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L139" href="#L139">139</a> <em class="jxr_javadoccomment"> * @param algorithms the algorithms to check for.</em>
<a class="jxr_linenumber" name="L140" href="#L140">140</a> <em class="jxr_javadoccomment"> * @return true if the checksums report that the the reference file is valid, false if invalid.</em>
<a class="jxr_linenumber" name="L141" href="#L141">141</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L142" href="#L142">142</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isValidChecksums( ChecksumAlgorithm algorithms[] )
<a class="jxr_linenumber" name="L143" href="#L143">143</a> {
<a class="jxr_linenumber" name="L144" href="#L144">144</a>
<a class="jxr_linenumber" name="L145" href="#L145">145</a> <strong class="jxr_keyword">try</strong> (InputStream fis = Files.newInputStream( referenceFile.toPath() ))
<a class="jxr_linenumber" name="L146" href="#L146">146</a> {
<a class="jxr_linenumber" name="L147" href="#L147">147</a> List&lt;Checksum&gt; checksums = <strong class="jxr_keyword">new</strong> ArrayList&lt;&gt;( algorithms.length );
<a class="jxr_linenumber" name="L148" href="#L148">148</a> <em class="jxr_comment">// Create checksum object for each algorithm.</em>
<a class="jxr_linenumber" name="L149" href="#L149">149</a> <strong class="jxr_keyword">for</strong> ( ChecksumAlgorithm checksumAlgorithm : algorithms )
<a class="jxr_linenumber" name="L150" href="#L150">150</a> {
<a class="jxr_linenumber" name="L151" href="#L151">151</a> File checksumFile = getChecksumFile( checksumAlgorithm );
<a class="jxr_linenumber" name="L152" href="#L152">152</a>
<a class="jxr_linenumber" name="L153" href="#L153">153</a> <em class="jxr_comment">// Only add algorithm if checksum file exists.</em>
<a class="jxr_linenumber" name="L154" href="#L154">154</a> <strong class="jxr_keyword">if</strong> ( checksumFile.exists() )
<a class="jxr_linenumber" name="L155" href="#L155">155</a> {
<a class="jxr_linenumber" name="L156" href="#L156">156</a> checksums.add( <strong class="jxr_keyword">new</strong> Checksum( checksumAlgorithm ) );
<a class="jxr_linenumber" name="L157" href="#L157">157</a> }
<a class="jxr_linenumber" name="L158" href="#L158">158</a> }
<a class="jxr_linenumber" name="L159" href="#L159">159</a>
<a class="jxr_linenumber" name="L160" href="#L160">160</a> <em class="jxr_comment">// Any checksums?</em>
<a class="jxr_linenumber" name="L161" href="#L161">161</a> <strong class="jxr_keyword">if</strong> ( checksums.isEmpty() )
<a class="jxr_linenumber" name="L162" href="#L162">162</a> {
<a class="jxr_linenumber" name="L163" href="#L163">163</a> <em class="jxr_comment">// No checksum objects, no checksum files, default to is invalid.</em>
<a class="jxr_linenumber" name="L164" href="#L164">164</a> <strong class="jxr_keyword">return</strong> false;
<a class="jxr_linenumber" name="L165" href="#L165">165</a> }
<a class="jxr_linenumber" name="L166" href="#L166">166</a>
<a class="jxr_linenumber" name="L167" href="#L167">167</a> <em class="jxr_comment">// Parse file once, for all checksums.</em>
<a class="jxr_linenumber" name="L168" href="#L168">168</a> <strong class="jxr_keyword">try</strong>
<a class="jxr_linenumber" name="L169" href="#L169">169</a> {
<a class="jxr_linenumber" name="L170" href="#L170">170</a> Checksum.update( checksums, fis );
<a class="jxr_linenumber" name="L171" href="#L171">171</a> }
<a class="jxr_linenumber" name="L172" href="#L172">172</a> <strong class="jxr_keyword">catch</strong> ( IOException e )
<a class="jxr_linenumber" name="L173" href="#L173">173</a> {
<a class="jxr_linenumber" name="L174" href="#L174">174</a> log.warn( <span class="jxr_string">"Unable to update checksum:{}"</span>, e.getMessage() );
<a class="jxr_linenumber" name="L175" href="#L175">175</a> <strong class="jxr_keyword">return</strong> false;
<a class="jxr_linenumber" name="L176" href="#L176">176</a> }
<a class="jxr_linenumber" name="L177" href="#L177">177</a>
<a class="jxr_linenumber" name="L178" href="#L178">178</a> <strong class="jxr_keyword">boolean</strong> valid = <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="L179" href="#L179">179</a>
<a class="jxr_linenumber" name="L180" href="#L180">180</a> <em class="jxr_comment">// check the checksum files</em>
<a class="jxr_linenumber" name="L181" href="#L181">181</a> <strong class="jxr_keyword">try</strong>
<a class="jxr_linenumber" name="L182" href="#L182">182</a> {
<a class="jxr_linenumber" name="L183" href="#L183">183</a> <strong class="jxr_keyword">for</strong> ( Checksum checksum : checksums )
<a class="jxr_linenumber" name="L184" href="#L184">184</a> {
<a class="jxr_linenumber" name="L185" href="#L185">185</a> <a href="../../../../org/apache/archiva/checksum/ChecksumAlgorithm.html">ChecksumAlgorithm</a> checksumAlgorithm = checksum.getAlgorithm();
<a class="jxr_linenumber" name="L186" href="#L186">186</a> File checksumFile = getChecksumFile( checksumAlgorithm );
<a class="jxr_linenumber" name="L187" href="#L187">187</a>
<a class="jxr_linenumber" name="L188" href="#L188">188</a> String rawChecksum = FileUtils.readFileToString( checksumFile );
<a class="jxr_linenumber" name="L189" href="#L189">189</a> String expectedChecksum = parseChecksum( rawChecksum, checksumAlgorithm, referenceFile.getName() );
<a class="jxr_linenumber" name="L190" href="#L190">190</a>
<a class="jxr_linenumber" name="L191" href="#L191">191</a> <strong class="jxr_keyword">if</strong> ( !StringUtils.equalsIgnoreCase( expectedChecksum, checksum.getChecksum() ) )
<a class="jxr_linenumber" name="L192" href="#L192">192</a> {
<a class="jxr_linenumber" name="L193" href="#L193">193</a> valid = false;
<a class="jxr_linenumber" name="L194" href="#L194">194</a> }
<a class="jxr_linenumber" name="L195" href="#L195">195</a> }
<a class="jxr_linenumber" name="L196" href="#L196">196</a> }
<a class="jxr_linenumber" name="L197" href="#L197">197</a> <strong class="jxr_keyword">catch</strong> ( IOException e )
<a class="jxr_linenumber" name="L198" href="#L198">198</a> {
<a class="jxr_linenumber" name="L199" href="#L199">199</a> log.warn( <span class="jxr_string">"Unable to read / parse checksum: {}"</span>, e.getMessage() );
<a class="jxr_linenumber" name="L200" href="#L200">200</a> <strong class="jxr_keyword">return</strong> false;
<a class="jxr_linenumber" name="L201" href="#L201">201</a> }
<a class="jxr_linenumber" name="L202" href="#L202">202</a>
<a class="jxr_linenumber" name="L203" href="#L203">203</a> <strong class="jxr_keyword">return</strong> valid;
<a class="jxr_linenumber" name="L204" href="#L204">204</a> }
<a class="jxr_linenumber" name="L205" href="#L205">205</a> <strong class="jxr_keyword">catch</strong> ( IOException e )
<a class="jxr_linenumber" name="L206" href="#L206">206</a> {
<a class="jxr_linenumber" name="L207" href="#L207">207</a> log.warn( <span class="jxr_string">"Unable to read / parse checksum: {}"</span>, e.getMessage() );
<a class="jxr_linenumber" name="L208" href="#L208">208</a> <strong class="jxr_keyword">return</strong> false;
<a class="jxr_linenumber" name="L209" href="#L209">209</a> }
<a class="jxr_linenumber" name="L210" href="#L210">210</a> }
<a class="jxr_linenumber" name="L211" href="#L211">211</a>
<a class="jxr_linenumber" name="L212" href="#L212">212</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L213" href="#L213">213</a> <em class="jxr_javadoccomment"> * Fix or create checksum files for the reference file.</em>
<a class="jxr_linenumber" name="L214" href="#L214">214</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L215" href="#L215">215</a> <em class="jxr_javadoccomment"> * @param algorithms the hashes to check for.</em>
<a class="jxr_linenumber" name="L216" href="#L216">216</a> <em class="jxr_javadoccomment"> * @return true if checksums were created successfully.</em>
<a class="jxr_linenumber" name="L217" href="#L217">217</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L218" href="#L218">218</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> fixChecksums( ChecksumAlgorithm[] algorithms )
<a class="jxr_linenumber" name="L219" href="#L219">219</a> {
<a class="jxr_linenumber" name="L220" href="#L220">220</a> List&lt;Checksum&gt; checksums = <strong class="jxr_keyword">new</strong> ArrayList&lt;&gt;( algorithms.length );
<a class="jxr_linenumber" name="L221" href="#L221">221</a> <em class="jxr_comment">// Create checksum object for each algorithm.</em>
<a class="jxr_linenumber" name="L222" href="#L222">222</a> <strong class="jxr_keyword">for</strong> ( ChecksumAlgorithm checksumAlgorithm : algorithms )
<a class="jxr_linenumber" name="L223" href="#L223">223</a> {
<a class="jxr_linenumber" name="L224" href="#L224">224</a> checksums.add( <strong class="jxr_keyword">new</strong> Checksum( checksumAlgorithm ) );
<a class="jxr_linenumber" name="L225" href="#L225">225</a> }
<a class="jxr_linenumber" name="L226" href="#L226">226</a>
<a class="jxr_linenumber" name="L227" href="#L227">227</a> <em class="jxr_comment">// Any checksums?</em>
<a class="jxr_linenumber" name="L228" href="#L228">228</a> <strong class="jxr_keyword">if</strong> ( checksums.isEmpty() )
<a class="jxr_linenumber" name="L229" href="#L229">229</a> {
<a class="jxr_linenumber" name="L230" href="#L230">230</a> <em class="jxr_comment">// No checksum objects, no checksum files, default to is valid.</em>
<a class="jxr_linenumber" name="L231" href="#L231">231</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="L232" href="#L232">232</a> }
<a class="jxr_linenumber" name="L233" href="#L233">233</a>
<a class="jxr_linenumber" name="L234" href="#L234">234</a> <strong class="jxr_keyword">try</strong> (InputStream fis = Files.newInputStream( referenceFile.toPath() ))
<a class="jxr_linenumber" name="L235" href="#L235">235</a> {
<a class="jxr_linenumber" name="L236" href="#L236">236</a> <em class="jxr_comment">// Parse file once, for all checksums.</em>
<a class="jxr_linenumber" name="L237" href="#L237">237</a> Checksum.update( checksums, fis );
<a class="jxr_linenumber" name="L238" href="#L238">238</a> }
<a class="jxr_linenumber" name="L239" href="#L239">239</a> <strong class="jxr_keyword">catch</strong> ( IOException e )
<a class="jxr_linenumber" name="L240" href="#L240">240</a> {
<a class="jxr_linenumber" name="L241" href="#L241">241</a> log.warn( e.getMessage(), e );
<a class="jxr_linenumber" name="L242" href="#L242">242</a> <strong class="jxr_keyword">return</strong> false;
<a class="jxr_linenumber" name="L243" href="#L243">243</a> }
<a class="jxr_linenumber" name="L244" href="#L244">244</a>
<a class="jxr_linenumber" name="L245" href="#L245">245</a> <strong class="jxr_keyword">boolean</strong> valid = <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="L246" href="#L246">246</a>
<a class="jxr_linenumber" name="L247" href="#L247">247</a> <em class="jxr_comment">// check the hash files</em>
<a class="jxr_linenumber" name="L248" href="#L248">248</a> <strong class="jxr_keyword">for</strong> ( Checksum checksum : checksums )
<a class="jxr_linenumber" name="L249" href="#L249">249</a> {
<a class="jxr_linenumber" name="L250" href="#L250">250</a> <a href="../../../../org/apache/archiva/checksum/ChecksumAlgorithm.html">ChecksumAlgorithm</a> checksumAlgorithm = checksum.getAlgorithm();
<a class="jxr_linenumber" name="L251" href="#L251">251</a> <strong class="jxr_keyword">try</strong>
<a class="jxr_linenumber" name="L252" href="#L252">252</a> {
<a class="jxr_linenumber" name="L253" href="#L253">253</a> File checksumFile = getChecksumFile( checksumAlgorithm );
<a class="jxr_linenumber" name="L254" href="#L254">254</a> String actualChecksum = checksum.getChecksum();
<a class="jxr_linenumber" name="L255" href="#L255">255</a>
<a class="jxr_linenumber" name="L256" href="#L256">256</a> <strong class="jxr_keyword">if</strong> ( checksumFile.exists() )
<a class="jxr_linenumber" name="L257" href="#L257">257</a> {
<a class="jxr_linenumber" name="L258" href="#L258">258</a> String rawChecksum = FileUtils.readFileToString( checksumFile );
<a class="jxr_linenumber" name="L259" href="#L259">259</a> String expectedChecksum = parseChecksum( rawChecksum, checksumAlgorithm, referenceFile.getName() );
<a class="jxr_linenumber" name="L260" href="#L260">260</a>
<a class="jxr_linenumber" name="L261" href="#L261">261</a> <strong class="jxr_keyword">if</strong> ( !StringUtils.equalsIgnoreCase( expectedChecksum, actualChecksum ) )
<a class="jxr_linenumber" name="L262" href="#L262">262</a> {
<a class="jxr_linenumber" name="L263" href="#L263">263</a> <em class="jxr_comment">// create checksum (again)</em>
<a class="jxr_linenumber" name="L264" href="#L264">264</a> FileUtils.writeStringToFile( checksumFile, actualChecksum + <span class="jxr_string">" "</span> + referenceFile.getName() );
<a class="jxr_linenumber" name="L265" href="#L265">265</a> }
<a class="jxr_linenumber" name="L266" href="#L266">266</a> }
<a class="jxr_linenumber" name="L267" href="#L267">267</a> <strong class="jxr_keyword">else</strong>
<a class="jxr_linenumber" name="L268" href="#L268">268</a> {
<a class="jxr_linenumber" name="L269" href="#L269">269</a> FileUtils.writeStringToFile( checksumFile, actualChecksum + <span class="jxr_string">" "</span> + referenceFile.getName() );
<a class="jxr_linenumber" name="L270" href="#L270">270</a> }
<a class="jxr_linenumber" name="L271" href="#L271">271</a> }
<a class="jxr_linenumber" name="L272" href="#L272">272</a> <strong class="jxr_keyword">catch</strong> ( IOException e )
<a class="jxr_linenumber" name="L273" href="#L273">273</a> {
<a class="jxr_linenumber" name="L274" href="#L274">274</a> log.warn( e.getMessage(), e );
<a class="jxr_linenumber" name="L275" href="#L275">275</a> valid = false;
<a class="jxr_linenumber" name="L276" href="#L276">276</a> }
<a class="jxr_linenumber" name="L277" href="#L277">277</a> }
<a class="jxr_linenumber" name="L278" href="#L278">278</a>
<a class="jxr_linenumber" name="L279" href="#L279">279</a> <strong class="jxr_keyword">return</strong> valid;
<a class="jxr_linenumber" name="L280" href="#L280">280</a>
<a class="jxr_linenumber" name="L281" href="#L281">281</a> }
<a class="jxr_linenumber" name="L282" href="#L282">282</a>
<a class="jxr_linenumber" name="L283" href="#L283">283</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> isValidChecksumPattern( String filename, String path )
<a class="jxr_linenumber" name="L284" href="#L284">284</a> {
<a class="jxr_linenumber" name="L285" href="#L285">285</a> <em class="jxr_comment">// check if it is a remote metadata file</em>
<a class="jxr_linenumber" name="L286" href="#L286">286</a>
<a class="jxr_linenumber" name="L287" href="#L287">287</a> Matcher m = METADATA_PATTERN.matcher( path );
<a class="jxr_linenumber" name="L288" href="#L288">288</a> <strong class="jxr_keyword">if</strong> ( m.matches() )
<a class="jxr_linenumber" name="L289" href="#L289">289</a> {
<a class="jxr_linenumber" name="L290" href="#L290">290</a> <strong class="jxr_keyword">return</strong> filename.endsWith( path ) || ( <span class="jxr_string">"-"</span>.equals( filename ) ) || filename.endsWith( <span class="jxr_string">"maven-metadata.xml"</span> );
<a class="jxr_linenumber" name="L291" href="#L291">291</a> }
<a class="jxr_linenumber" name="L292" href="#L292">292</a>
<a class="jxr_linenumber" name="L293" href="#L293">293</a> <strong class="jxr_keyword">return</strong> filename.endsWith( path ) || ( <span class="jxr_string">"-"</span>.equals( filename ) );
<a class="jxr_linenumber" name="L294" href="#L294">294</a> }
<a class="jxr_linenumber" name="L295" href="#L295">295</a>
<a class="jxr_linenumber" name="L296" href="#L296">296</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L297" href="#L297">297</a> <em class="jxr_javadoccomment"> * Parse a checksum string.</em>
<a class="jxr_linenumber" name="L298" href="#L298">298</a> <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a class="jxr_linenumber" name="L299" href="#L299">299</a> <em class="jxr_javadoccomment"> * Validate the expected path, and expected checksum algorithm, then return</em>
<a class="jxr_linenumber" name="L300" href="#L300">300</a> <em class="jxr_javadoccomment"> * the trimmed checksum hex string.</em>
<a class="jxr_linenumber" name="L301" href="#L301">301</a> <em class="jxr_javadoccomment"> * &lt;/p&gt;</em>
<a class="jxr_linenumber" name="L302" href="#L302">302</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L303" href="#L303">303</a> <em class="jxr_javadoccomment"> * @param rawChecksumString</em>
<a class="jxr_linenumber" name="L304" href="#L304">304</a> <em class="jxr_javadoccomment"> * @param expectedHash</em>
<a class="jxr_linenumber" name="L305" href="#L305">305</a> <em class="jxr_javadoccomment"> * @param expectedPath</em>
<a class="jxr_linenumber" name="L306" href="#L306">306</a> <em class="jxr_javadoccomment"> * @return</em>
<a class="jxr_linenumber" name="L307" href="#L307">307</a> <em class="jxr_javadoccomment"> * @throws IOException</em>
<a class="jxr_linenumber" name="L308" href="#L308">308</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L309" href="#L309">309</a> <strong class="jxr_keyword">public</strong> String parseChecksum( String rawChecksumString, ChecksumAlgorithm expectedHash, String expectedPath )
<a class="jxr_linenumber" name="L310" href="#L310">310</a> <strong class="jxr_keyword">throws</strong> IOException
<a class="jxr_linenumber" name="L311" href="#L311">311</a> {
<a class="jxr_linenumber" name="L312" href="#L312">312</a> String trimmedChecksum = rawChecksumString.replace( '\n', ' ' ).trim();
<a class="jxr_linenumber" name="L313" href="#L313">313</a>
<a class="jxr_linenumber" name="L314" href="#L314">314</a> <em class="jxr_comment">// Free-BSD / openssl</em>
<a class="jxr_linenumber" name="L315" href="#L315">315</a> String regex = expectedHash.getType() + <span class="jxr_string">"&#92;&#92;s*&#92;&#92;(([^)]*)&#92;&#92;)&#92;&#92;s*=&#92;&#92;s*([a-fA-F0-9]+)"</span>;
<a class="jxr_linenumber" name="L316" href="#L316">316</a> Matcher m = Pattern.compile( regex ).matcher( trimmedChecksum );
<a class="jxr_linenumber" name="L317" href="#L317">317</a> <strong class="jxr_keyword">if</strong> ( m.matches() )
<a class="jxr_linenumber" name="L318" href="#L318">318</a> {
<a class="jxr_linenumber" name="L319" href="#L319">319</a> String filename = m.group( 1 );
<a class="jxr_linenumber" name="L320" href="#L320">320</a> <strong class="jxr_keyword">if</strong> ( !isValidChecksumPattern( filename, expectedPath ) )
<a class="jxr_linenumber" name="L321" href="#L321">321</a> {
<a class="jxr_linenumber" name="L322" href="#L322">322</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IOException(
<a class="jxr_linenumber" name="L323" href="#L323">323</a> <span class="jxr_string">"Supplied checksum file '"</span> + filename + <span class="jxr_string">"' does not match expected file: '"</span> + expectedPath + <span class="jxr_string">"'"</span> );
<a class="jxr_linenumber" name="L324" href="#L324">324</a> }
<a class="jxr_linenumber" name="L325" href="#L325">325</a> trimmedChecksum = m.group( 2 );
<a class="jxr_linenumber" name="L326" href="#L326">326</a> }
<a class="jxr_linenumber" name="L327" href="#L327">327</a> <strong class="jxr_keyword">else</strong>
<a class="jxr_linenumber" name="L328" href="#L328">328</a> {
<a class="jxr_linenumber" name="L329" href="#L329">329</a> <em class="jxr_comment">// GNU tools</em>
<a class="jxr_linenumber" name="L330" href="#L330">330</a> m = Pattern.compile( <span class="jxr_string">"([a-fA-F0-9]+)&#92;&#92;s+&#92;&#92;*?(.+)"</span> ).matcher( trimmedChecksum );
<a class="jxr_linenumber" name="L331" href="#L331">331</a> <strong class="jxr_keyword">if</strong> ( m.matches() )
<a class="jxr_linenumber" name="L332" href="#L332">332</a> {
<a class="jxr_linenumber" name="L333" href="#L333">333</a> String filename = m.group( 2 );
<a class="jxr_linenumber" name="L334" href="#L334">334</a> <strong class="jxr_keyword">if</strong> ( !isValidChecksumPattern( filename, expectedPath ) )
<a class="jxr_linenumber" name="L335" href="#L335">335</a> {
<a class="jxr_linenumber" name="L336" href="#L336">336</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IOException(
<a class="jxr_linenumber" name="L337" href="#L337">337</a> <span class="jxr_string">"Supplied checksum file '"</span> + filename + <span class="jxr_string">"' does not match expected file: '"</span> + expectedPath
<a class="jxr_linenumber" name="L338" href="#L338">338</a> + <span class="jxr_string">"'"</span> );
<a class="jxr_linenumber" name="L339" href="#L339">339</a> }
<a class="jxr_linenumber" name="L340" href="#L340">340</a> trimmedChecksum = m.group( 1 );
<a class="jxr_linenumber" name="L341" href="#L341">341</a> }
<a class="jxr_linenumber" name="L342" href="#L342">342</a> }
<a class="jxr_linenumber" name="L343" href="#L343">343</a> <strong class="jxr_keyword">return</strong> trimmedChecksum;
<a class="jxr_linenumber" name="L344" href="#L344">344</a> }
<a class="jxr_linenumber" name="L345" href="#L345">345</a> }
</pre>
<hr/>
<div id="footer">Copyright &#169; 2006&#x2013;2017 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div>
</body>
</html>