github-mirrors/DependencyCheck
1
0
Fork 0
mirror of https://github.com/ysoftdevs/DependencyCheck.git synced 2026-01-14 15:53:36 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
DependencyCheck/xref/org/owasp/dependencycheck/utils/ExtractionUtil.html
Jeremy Long 615f6e3750 documentation version 1.4.5
2017-01-22 17:22:46 -05:00

334 lines
43 KiB
HTML
Raw Permalink Blame History

<!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>ExtractionUtil xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../apidocs/org/owasp/dependencycheck/utils/ExtractionUtil.html">View Javadoc</a></div><pre>
<a class="jxr_linenumber" name="L1" href="#L1">1</a> <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="L2" href="#L2">2</a> <em class="jxr_comment"> * This file is part of dependency-check-core.</em>
<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 under the Apache License, Version 2.0 (the "License");</em>
<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * you may not use this file except in compliance with the License.</em>
<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * You may obtain a copy of the License at</em>
<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="L8" href="#L8">8</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="L9" href="#L9">9</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em>
<a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
<a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> * See the License for the specific language governing permissions and</em>
<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * limitations under the License.</em>
<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> * Copyright (c) 2013 Jeremy Long. All Rights Reserved.</em>
<a class="jxr_linenumber" name="L17" href="#L17">17</a> <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="L18" href="#L18">18</a> <strong class="jxr_keyword">package</strong> org.owasp.dependencycheck.utils;
<a class="jxr_linenumber" name="L19" href="#L19">19</a>
<a class="jxr_linenumber" name="L20" href="#L20">20</a> <strong class="jxr_keyword">import</strong> java.io.BufferedInputStream;
<a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> java.io.File;
<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> java.io.FileInputStream;
<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> java.io.FileNotFoundException;
<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> java.io.FileOutputStream;
<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> java.io.FilenameFilter;
<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> java.io.IOException;
<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> java.util.zip.GZIPInputStream;
<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> java.util.zip.ZipEntry;
<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> java.util.zip.ZipInputStream;
<a class="jxr_linenumber" name="L30" href="#L30">30</a>
<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> org.apache.commons.compress.archivers.ArchiveEntry;
<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> org.apache.commons.compress.archivers.ArchiveInputStream;
<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> org.apache.commons.compress.archivers.zip.ZipArchiveInputStream;
<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> org.apache.commons.compress.utils.IOUtils;
<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.Engine;
<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.analyzer.exception.AnalysisException;
<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.analyzer.exception.ArchiveExtractionException;
<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">import</strong> org.slf4j.Logger;
<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory;
<a class="jxr_linenumber" name="L40" href="#L40">40</a>
<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> * Set of utilities to extract files from archives.</em>
<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> * @author Jeremy Long</em>
<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L46" href="#L46">46</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/owasp/dependencycheck/utils/ExtractionUtil.html">ExtractionUtil</a> {
<a class="jxr_linenumber" name="L47" href="#L47">47</a>
<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> * The logger.</em>
<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L51" href="#L51">51</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Logger LOGGER = LoggerFactory.getLogger(ExtractionUtil.<strong class="jxr_keyword">class</strong>);
<a class="jxr_linenumber" name="L52" href="#L52">52</a>
<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment"> * Private constructor for a utility class.</em>
<a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L56" href="#L56">56</a> <strong class="jxr_keyword">private</strong> <a href="../../../../org/owasp/dependencycheck/utils/ExtractionUtil.html">ExtractionUtil</a>() {
<a class="jxr_linenumber" name="L57" href="#L57">57</a> }
<a class="jxr_linenumber" name="L58" href="#L58">58</a>
<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment"> * Extracts the contents of an archive into the specified directory.</em>
<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> * @param archive an archive file such as a WAR or EAR</em>
<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> * @param extractTo a directory to extract the contents to</em>
<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> * @throws ExtractionException thrown if an exception occurs while</em>
<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment"> * extracting the files</em>
<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L67" href="#L67">67</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> extractFiles(File archive, File extractTo) <strong class="jxr_keyword">throws</strong> ExtractionException {
<a class="jxr_linenumber" name="L68" href="#L68">68</a> extractFiles(archive, extractTo, <strong class="jxr_keyword">null</strong>);
<a class="jxr_linenumber" name="L69" href="#L69">69</a> }
<a class="jxr_linenumber" name="L70" href="#L70">70</a>
<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> * Extracts the contents of an archive into the specified directory. The</em>
<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> * files are only extracted if they are supported by the analyzers loaded</em>
<a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment"> * into the specified engine. If the engine is specified as null then all</em>
<a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment"> * files are extracted.</em>
<a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment"> * @param archive an archive file such as a WAR or EAR</em>
<a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_javadoccomment"> * @param extractTo a directory to extract the contents to</em>
<a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_javadoccomment"> * @param engine the scanning engine</em>
<a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_javadoccomment"> * @throws ExtractionException thrown if there is an error extracting the</em>
<a class="jxr_linenumber" name="L81" href="#L81">81</a> <em class="jxr_javadoccomment"> * files</em>
<a class="jxr_linenumber" name="L82" href="#L82">82</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L83" href="#L83">83</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> extractFiles(File archive, File extractTo, <a href="../../../../org/owasp/dependencycheck/Engine.html">Engine</a> engine) <strong class="jxr_keyword">throws</strong> ExtractionException {
<a class="jxr_linenumber" name="L84" href="#L84">84</a> <strong class="jxr_keyword">if</strong> (archive == <strong class="jxr_keyword">null</strong> || extractTo == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L85" href="#L85">85</a> <strong class="jxr_keyword">return</strong>;
<a class="jxr_linenumber" name="L86" href="#L86">86</a> }
<a class="jxr_linenumber" name="L87" href="#L87">87</a>
<a class="jxr_linenumber" name="L88" href="#L88">88</a> FileInputStream fis = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L89" href="#L89">89</a> ZipInputStream zis = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L90" href="#L90">90</a>
<a class="jxr_linenumber" name="L91" href="#L91">91</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L92" href="#L92">92</a> fis = <strong class="jxr_keyword">new</strong> FileInputStream(archive);
<a class="jxr_linenumber" name="L93" href="#L93">93</a> } <strong class="jxr_keyword">catch</strong> (FileNotFoundException ex) {
<a class="jxr_linenumber" name="L94" href="#L94">94</a> LOGGER.debug(<span class="jxr_string">""</span>, ex);
<a class="jxr_linenumber" name="L95" href="#L95">95</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/owasp/dependencycheck/utils/ExtractionException.html">ExtractionException</a>(<span class="jxr_string">"Archive file was not found."</span>, ex);
<a class="jxr_linenumber" name="L96" href="#L96">96</a> }
<a class="jxr_linenumber" name="L97" href="#L97">97</a> zis = <strong class="jxr_keyword">new</strong> ZipInputStream(<strong class="jxr_keyword">new</strong> BufferedInputStream(fis));
<a class="jxr_linenumber" name="L98" href="#L98">98</a> ZipEntry entry;
<a class="jxr_linenumber" name="L99" href="#L99">99</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L100" href="#L100">100</a> <strong class="jxr_keyword">while</strong> ((entry = zis.getNextEntry()) != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L101" href="#L101">101</a> <strong class="jxr_keyword">if</strong> (entry.isDirectory()) {
<a class="jxr_linenumber" name="L102" href="#L102">102</a> <strong class="jxr_keyword">final</strong> File d = <strong class="jxr_keyword">new</strong> File(extractTo, entry.getName());
<a class="jxr_linenumber" name="L103" href="#L103">103</a> <strong class="jxr_keyword">if</strong> (!d.exists() &amp;&amp; !d.mkdirs()) {
<a class="jxr_linenumber" name="L104" href="#L104">104</a> <strong class="jxr_keyword">final</strong> String msg = String.format(<span class="jxr_string">"Unable to create '%s'."</span>, d.getAbsolutePath());
<a class="jxr_linenumber" name="L105" href="#L105">105</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/owasp/dependencycheck/utils/ExtractionException.html">ExtractionException</a>(msg);
<a class="jxr_linenumber" name="L106" href="#L106">106</a> }
<a class="jxr_linenumber" name="L107" href="#L107">107</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L108" href="#L108">108</a> <strong class="jxr_keyword">final</strong> File file = <strong class="jxr_keyword">new</strong> File(extractTo, entry.getName());
<a class="jxr_linenumber" name="L109" href="#L109">109</a> <strong class="jxr_keyword">if</strong> (engine == <strong class="jxr_keyword">null</strong> || engine.accept(file)) {
<a class="jxr_linenumber" name="L110" href="#L110">110</a> FileOutputStream fos = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L111" href="#L111">111</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L112" href="#L112">112</a> fos = <strong class="jxr_keyword">new</strong> FileOutputStream(file);
<a class="jxr_linenumber" name="L113" href="#L113">113</a> IOUtils.copy(zis, fos);
<a class="jxr_linenumber" name="L114" href="#L114">114</a> } <strong class="jxr_keyword">catch</strong> (FileNotFoundException ex) {
<a class="jxr_linenumber" name="L115" href="#L115">115</a> LOGGER.debug(<span class="jxr_string">""</span>, ex);
<a class="jxr_linenumber" name="L116" href="#L116">116</a> <strong class="jxr_keyword">final</strong> String msg = String.format(<span class="jxr_string">"Unable to find file '%s'."</span>, file.getName());
<a class="jxr_linenumber" name="L117" href="#L117">117</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/owasp/dependencycheck/utils/ExtractionException.html">ExtractionException</a>(msg, ex);
<a class="jxr_linenumber" name="L118" href="#L118">118</a> } <strong class="jxr_keyword">catch</strong> (IOException ex) {
<a class="jxr_linenumber" name="L119" href="#L119">119</a> LOGGER.debug(<span class="jxr_string">""</span>, ex);
<a class="jxr_linenumber" name="L120" href="#L120">120</a> <strong class="jxr_keyword">final</strong> String msg = String.format(<span class="jxr_string">"IO Exception while parsing file '%s'."</span>, file.getName());
<a class="jxr_linenumber" name="L121" href="#L121">121</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/owasp/dependencycheck/utils/ExtractionException.html">ExtractionException</a>(msg, ex);
<a class="jxr_linenumber" name="L122" href="#L122">122</a> } <strong class="jxr_keyword">finally</strong> {
<a class="jxr_linenumber" name="L123" href="#L123">123</a> FileUtils.close(fos);
<a class="jxr_linenumber" name="L124" href="#L124">124</a> }
<a class="jxr_linenumber" name="L125" href="#L125">125</a> }
<a class="jxr_linenumber" name="L126" href="#L126">126</a> }
<a class="jxr_linenumber" name="L127" href="#L127">127</a> }
<a class="jxr_linenumber" name="L128" href="#L128">128</a> } <strong class="jxr_keyword">catch</strong> (IOException ex) {
<a class="jxr_linenumber" name="L129" href="#L129">129</a> <strong class="jxr_keyword">final</strong> String msg = String.format(<span class="jxr_string">"Exception reading archive '%s'."</span>, archive.getName());
<a class="jxr_linenumber" name="L130" href="#L130">130</a> LOGGER.debug(<span class="jxr_string">""</span>, ex);
<a class="jxr_linenumber" name="L131" href="#L131">131</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/owasp/dependencycheck/utils/ExtractionException.html">ExtractionException</a>(msg, ex);
<a class="jxr_linenumber" name="L132" href="#L132">132</a> } <strong class="jxr_keyword">finally</strong> {
<a class="jxr_linenumber" name="L133" href="#L133">133</a> FileUtils.close(zis);
<a class="jxr_linenumber" name="L134" href="#L134">134</a> }
<a class="jxr_linenumber" name="L135" href="#L135">135</a> }
<a class="jxr_linenumber" name="L136" href="#L136">136</a>
<a class="jxr_linenumber" name="L137" href="#L137">137</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L138" href="#L138">138</a> <em class="jxr_javadoccomment"> * Extracts the contents of an archive into the specified directory.</em>
<a class="jxr_linenumber" name="L139" href="#L139">139</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L140" href="#L140">140</a> <em class="jxr_javadoccomment"> * @param archive an archive file such as a WAR or EAR</em>
<a class="jxr_linenumber" name="L141" href="#L141">141</a> <em class="jxr_javadoccomment"> * @param destination a directory to extract the contents to</em>
<a class="jxr_linenumber" name="L142" href="#L142">142</a> <em class="jxr_javadoccomment"> * @param filter determines which files get extracted</em>
<a class="jxr_linenumber" name="L143" href="#L143">143</a> <em class="jxr_javadoccomment"> * @throws ExtractionException thrown if the archive is not found</em>
<a class="jxr_linenumber" name="L144" href="#L144">144</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L145" href="#L145">145</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> extractFilesUsingFilter(File archive, File destination,
<a class="jxr_linenumber" name="L146" href="#L146">146</a> FilenameFilter filter) <strong class="jxr_keyword">throws</strong> ExtractionException {
<a class="jxr_linenumber" name="L147" href="#L147">147</a> <strong class="jxr_keyword">if</strong> (archive == <strong class="jxr_keyword">null</strong> || destination == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L148" href="#L148">148</a> <strong class="jxr_keyword">return</strong>;
<a class="jxr_linenumber" name="L149" href="#L149">149</a> }
<a class="jxr_linenumber" name="L150" href="#L150">150</a>
<a class="jxr_linenumber" name="L151" href="#L151">151</a> FileInputStream fis = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L152" href="#L152">152</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L153" href="#L153">153</a> fis = <strong class="jxr_keyword">new</strong> FileInputStream(archive);
<a class="jxr_linenumber" name="L154" href="#L154">154</a> } <strong class="jxr_keyword">catch</strong> (FileNotFoundException ex) {
<a class="jxr_linenumber" name="L155" href="#L155">155</a> LOGGER.debug(<span class="jxr_string">""</span>, ex);
<a class="jxr_linenumber" name="L156" href="#L156">156</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/owasp/dependencycheck/utils/ExtractionException.html">ExtractionException</a>(<span class="jxr_string">"Archive file was not found."</span>, ex);
<a class="jxr_linenumber" name="L157" href="#L157">157</a> }
<a class="jxr_linenumber" name="L158" href="#L158">158</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L159" href="#L159">159</a> extractArchive(<strong class="jxr_keyword">new</strong> ZipArchiveInputStream(<strong class="jxr_keyword">new</strong> BufferedInputStream(
<a class="jxr_linenumber" name="L160" href="#L160">160</a> fis)), destination, filter);
<a class="jxr_linenumber" name="L161" href="#L161">161</a> } <strong class="jxr_keyword">catch</strong> (ArchiveExtractionException ex) {
<a class="jxr_linenumber" name="L162" href="#L162">162</a> LOGGER.warn(<span class="jxr_string">"Exception extracting archive '{}'."</span>, archive.getName());
<a class="jxr_linenumber" name="L163" href="#L163">163</a> LOGGER.debug(<span class="jxr_string">""</span>, ex);
<a class="jxr_linenumber" name="L164" href="#L164">164</a> } <strong class="jxr_keyword">finally</strong> {
<a class="jxr_linenumber" name="L165" href="#L165">165</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L166" href="#L166">166</a> fis.close();
<a class="jxr_linenumber" name="L167" href="#L167">167</a> } <strong class="jxr_keyword">catch</strong> (IOException ex) {
<a class="jxr_linenumber" name="L168" href="#L168">168</a> LOGGER.debug(<span class="jxr_string">""</span>, ex);
<a class="jxr_linenumber" name="L169" href="#L169">169</a> }
<a class="jxr_linenumber" name="L170" href="#L170">170</a> }
<a class="jxr_linenumber" name="L171" href="#L171">171</a> }
<a class="jxr_linenumber" name="L172" href="#L172">172</a>
<a class="jxr_linenumber" name="L173" href="#L173">173</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L174" href="#L174">174</a> <em class="jxr_javadoccomment"> * Extracts files from an archive.</em>
<a class="jxr_linenumber" name="L175" href="#L175">175</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L176" href="#L176">176</a> <em class="jxr_javadoccomment"> * @param input the archive to extract files from</em>
<a class="jxr_linenumber" name="L177" href="#L177">177</a> <em class="jxr_javadoccomment"> * @param destination the location to write the files too</em>
<a class="jxr_linenumber" name="L178" href="#L178">178</a> <em class="jxr_javadoccomment"> * @param filter determines which files get extracted</em>
<a class="jxr_linenumber" name="L179" href="#L179">179</a> <em class="jxr_javadoccomment"> * @throws ArchiveExtractionException thrown if there is an exception</em>
<a class="jxr_linenumber" name="L180" href="#L180">180</a> <em class="jxr_javadoccomment"> * extracting files from the archive</em>
<a class="jxr_linenumber" name="L181" href="#L181">181</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L182" href="#L182">182</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> extractArchive(ArchiveInputStream input,
<a class="jxr_linenumber" name="L183" href="#L183">183</a> File destination, FilenameFilter filter)
<a class="jxr_linenumber" name="L184" href="#L184">184</a> <strong class="jxr_keyword">throws</strong> <a href="../../../../org/owasp/dependencycheck/analyzer/exception/ArchiveExtractionException.html">ArchiveExtractionException</a> {
<a class="jxr_linenumber" name="L185" href="#L185">185</a> ArchiveEntry entry;
<a class="jxr_linenumber" name="L186" href="#L186">186</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L187" href="#L187">187</a> <strong class="jxr_keyword">while</strong> ((entry = input.getNextEntry()) != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L188" href="#L188">188</a> <strong class="jxr_keyword">if</strong> (entry.isDirectory()) {
<a class="jxr_linenumber" name="L189" href="#L189">189</a> <strong class="jxr_keyword">final</strong> File dir = <strong class="jxr_keyword">new</strong> File(destination, entry.getName());
<a class="jxr_linenumber" name="L190" href="#L190">190</a> <strong class="jxr_keyword">if</strong> (!dir.exists() &amp;&amp; !dir.mkdirs()) {
<a class="jxr_linenumber" name="L191" href="#L191">191</a> <strong class="jxr_keyword">final</strong> String msg = String.format(
<a class="jxr_linenumber" name="L192" href="#L192">192</a> <span class="jxr_string">"Unable to create directory '%s'."</span>,
<a class="jxr_linenumber" name="L193" href="#L193">193</a> dir.getAbsolutePath());
<a class="jxr_linenumber" name="L194" href="#L194">194</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/owasp/dependencycheck/analyzer/exception/AnalysisException.html">AnalysisException</a>(msg);
<a class="jxr_linenumber" name="L195" href="#L195">195</a> }
<a class="jxr_linenumber" name="L196" href="#L196">196</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L197" href="#L197">197</a> extractFile(input, destination, filter, entry);
<a class="jxr_linenumber" name="L198" href="#L198">198</a> }
<a class="jxr_linenumber" name="L199" href="#L199">199</a> }
<a class="jxr_linenumber" name="L200" href="#L200">200</a> } <strong class="jxr_keyword">catch</strong> (IOException ex) {
<a class="jxr_linenumber" name="L201" href="#L201">201</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/owasp/dependencycheck/analyzer/exception/ArchiveExtractionException.html">ArchiveExtractionException</a>(ex);
<a class="jxr_linenumber" name="L202" href="#L202">202</a> } <strong class="jxr_keyword">catch</strong> (Throwable ex) {
<a class="jxr_linenumber" name="L203" href="#L203">203</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/owasp/dependencycheck/analyzer/exception/ArchiveExtractionException.html">ArchiveExtractionException</a>(ex);
<a class="jxr_linenumber" name="L204" href="#L204">204</a> } <strong class="jxr_keyword">finally</strong> {
<a class="jxr_linenumber" name="L205" href="#L205">205</a> FileUtils.close(input);
<a class="jxr_linenumber" name="L206" href="#L206">206</a> }
<a class="jxr_linenumber" name="L207" href="#L207">207</a> }
<a class="jxr_linenumber" name="L208" href="#L208">208</a>
<a class="jxr_linenumber" name="L209" href="#L209">209</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L210" href="#L210">210</a> <em class="jxr_javadoccomment"> * Extracts a file from an archive (input stream) and correctly builds the</em>
<a class="jxr_linenumber" name="L211" href="#L211">211</a> <em class="jxr_javadoccomment"> * directory structure.</em>
<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"> * @param input the archive input stream</em>
<a class="jxr_linenumber" name="L214" href="#L214">214</a> <em class="jxr_javadoccomment"> * @param destination where to write the file</em>
<a class="jxr_linenumber" name="L215" href="#L215">215</a> <em class="jxr_javadoccomment"> * @param filter the file filter to apply to the files being extracted</em>
<a class="jxr_linenumber" name="L216" href="#L216">216</a> <em class="jxr_javadoccomment"> * @param entry the entry from the archive to extract</em>
<a class="jxr_linenumber" name="L217" href="#L217">217</a> <em class="jxr_javadoccomment"> * @throws ExtractionException thrown if there is an error reading from the</em>
<a class="jxr_linenumber" name="L218" href="#L218">218</a> <em class="jxr_javadoccomment"> * archive stream</em>
<a class="jxr_linenumber" name="L219" href="#L219">219</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L220" href="#L220">220</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> extractFile(ArchiveInputStream input, File destination,
<a class="jxr_linenumber" name="L221" href="#L221">221</a> FilenameFilter filter, ArchiveEntry entry) <strong class="jxr_keyword">throws</strong> ExtractionException {
<a class="jxr_linenumber" name="L222" href="#L222">222</a> <strong class="jxr_keyword">final</strong> File file = <strong class="jxr_keyword">new</strong> File(destination, entry.getName());
<a class="jxr_linenumber" name="L223" href="#L223">223</a> <strong class="jxr_keyword">if</strong> (filter.accept(file.getParentFile(), file.getName())) {
<a class="jxr_linenumber" name="L224" href="#L224">224</a> LOGGER.debug(<span class="jxr_string">"Extracting '{}'"</span>,
<a class="jxr_linenumber" name="L225" href="#L225">225</a> file.getPath());
<a class="jxr_linenumber" name="L226" href="#L226">226</a> FileOutputStream fos = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L227" href="#L227">227</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L228" href="#L228">228</a> createParentFile(file);
<a class="jxr_linenumber" name="L229" href="#L229">229</a> fos = <strong class="jxr_keyword">new</strong> FileOutputStream(file);
<a class="jxr_linenumber" name="L230" href="#L230">230</a> IOUtils.copy(input, fos);
<a class="jxr_linenumber" name="L231" href="#L231">231</a> } <strong class="jxr_keyword">catch</strong> (FileNotFoundException ex) {
<a class="jxr_linenumber" name="L232" href="#L232">232</a> LOGGER.debug(<span class="jxr_string">""</span>, ex);
<a class="jxr_linenumber" name="L233" href="#L233">233</a> <strong class="jxr_keyword">final</strong> String msg = String.format(<span class="jxr_string">"Unable to find file '%s'."</span>,
<a class="jxr_linenumber" name="L234" href="#L234">234</a> file.getName());
<a class="jxr_linenumber" name="L235" href="#L235">235</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/owasp/dependencycheck/utils/ExtractionException.html">ExtractionException</a>(msg, ex);
<a class="jxr_linenumber" name="L236" href="#L236">236</a> } <strong class="jxr_keyword">catch</strong> (IOException ex) {
<a class="jxr_linenumber" name="L237" href="#L237">237</a> LOGGER.debug(<span class="jxr_string">""</span>, ex);
<a class="jxr_linenumber" name="L238" href="#L238">238</a> <strong class="jxr_keyword">final</strong> String msg = String
<a class="jxr_linenumber" name="L239" href="#L239">239</a> .format(<span class="jxr_string">"IO Exception while parsing file '%s'."</span>,
<a class="jxr_linenumber" name="L240" href="#L240">240</a> file.getName());
<a class="jxr_linenumber" name="L241" href="#L241">241</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/owasp/dependencycheck/utils/ExtractionException.html">ExtractionException</a>(msg, ex);
<a class="jxr_linenumber" name="L242" href="#L242">242</a> } <strong class="jxr_keyword">finally</strong> {
<a class="jxr_linenumber" name="L243" href="#L243">243</a> FileUtils.close(fos);
<a class="jxr_linenumber" name="L244" href="#L244">244</a> }
<a class="jxr_linenumber" name="L245" href="#L245">245</a> }
<a class="jxr_linenumber" name="L246" href="#L246">246</a> }
<a class="jxr_linenumber" name="L247" href="#L247">247</a>
<a class="jxr_linenumber" name="L248" href="#L248">248</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L249" href="#L249">249</a> <em class="jxr_javadoccomment"> * Ensures the parent path is correctly created on disk so that the file can</em>
<a class="jxr_linenumber" name="L250" href="#L250">250</a> <em class="jxr_javadoccomment"> * be extracted to the correct location.</em>
<a class="jxr_linenumber" name="L251" href="#L251">251</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L252" href="#L252">252</a> <em class="jxr_javadoccomment"> * @param file the file path</em>
<a class="jxr_linenumber" name="L253" href="#L253">253</a> <em class="jxr_javadoccomment"> * @throws ExtractionException thrown if the parent paths could not be</em>
<a class="jxr_linenumber" name="L254" href="#L254">254</a> <em class="jxr_javadoccomment"> * created</em>
<a class="jxr_linenumber" name="L255" href="#L255">255</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L256" href="#L256">256</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> createParentFile(<strong class="jxr_keyword">final</strong> File file)
<a class="jxr_linenumber" name="L257" href="#L257">257</a> <strong class="jxr_keyword">throws</strong> <a href="../../../../org/owasp/dependencycheck/utils/ExtractionException.html">ExtractionException</a> {
<a class="jxr_linenumber" name="L258" href="#L258">258</a> <strong class="jxr_keyword">final</strong> File parent = file.getParentFile();
<a class="jxr_linenumber" name="L259" href="#L259">259</a> <strong class="jxr_keyword">if</strong> (!parent.isDirectory() &amp;&amp; !parent.mkdirs()) {
<a class="jxr_linenumber" name="L260" href="#L260">260</a> <strong class="jxr_keyword">final</strong> String msg = String.format(
<a class="jxr_linenumber" name="L261" href="#L261">261</a> <span class="jxr_string">"Unable to build directory '%s'."</span>,
<a class="jxr_linenumber" name="L262" href="#L262">262</a> parent.getAbsolutePath());
<a class="jxr_linenumber" name="L263" href="#L263">263</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/owasp/dependencycheck/utils/ExtractionException.html">ExtractionException</a>(msg);
<a class="jxr_linenumber" name="L264" href="#L264">264</a> }
<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> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L268" href="#L268">268</a> <em class="jxr_javadoccomment"> * Extracts the file contained in a gzip archive. The extracted file is</em>
<a class="jxr_linenumber" name="L269" href="#L269">269</a> <em class="jxr_javadoccomment"> * placed in the exact same path as the file specified.</em>
<a class="jxr_linenumber" name="L270" href="#L270">270</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L271" href="#L271">271</a> <em class="jxr_javadoccomment"> * @param file the archive file</em>
<a class="jxr_linenumber" name="L272" href="#L272">272</a> <em class="jxr_javadoccomment"> * @throws FileNotFoundException thrown if the file does not exist</em>
<a class="jxr_linenumber" name="L273" href="#L273">273</a> <em class="jxr_javadoccomment"> * @throws IOException thrown if there is an error extracting the file.</em>
<a class="jxr_linenumber" name="L274" href="#L274">274</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L275" href="#L275">275</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> extractGzip(File file) <strong class="jxr_keyword">throws</strong> FileNotFoundException, IOException {
<a class="jxr_linenumber" name="L276" href="#L276">276</a> <strong class="jxr_keyword">final</strong> String originalPath = file.getPath();
<a class="jxr_linenumber" name="L277" href="#L277">277</a> <strong class="jxr_keyword">final</strong> File gzip = <strong class="jxr_keyword">new</strong> File(originalPath + <span class="jxr_string">".gz"</span>);
<a class="jxr_linenumber" name="L278" href="#L278">278</a> <strong class="jxr_keyword">if</strong> (gzip.isFile() &amp;&amp; !gzip.delete()) {
<a class="jxr_linenumber" name="L279" href="#L279">279</a> LOGGER.debug(<span class="jxr_string">"Failed to delete initial temporary file when extracting 'gz' {}"</span>, gzip.toString());
<a class="jxr_linenumber" name="L280" href="#L280">280</a> gzip.deleteOnExit();
<a class="jxr_linenumber" name="L281" href="#L281">281</a> }
<a class="jxr_linenumber" name="L282" href="#L282">282</a> <strong class="jxr_keyword">if</strong> (!file.renameTo(gzip)) {
<a class="jxr_linenumber" name="L283" href="#L283">283</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IOException(<span class="jxr_string">"Unable to rename '"</span> + file.getPath() + <span class="jxr_string">"'"</span>);
<a class="jxr_linenumber" name="L284" href="#L284">284</a> }
<a class="jxr_linenumber" name="L285" href="#L285">285</a> <strong class="jxr_keyword">final</strong> File newfile = <strong class="jxr_keyword">new</strong> File(originalPath);
<a class="jxr_linenumber" name="L286" href="#L286">286</a>
<a class="jxr_linenumber" name="L287" href="#L287">287</a> <strong class="jxr_keyword">final</strong> byte[] buffer = <strong class="jxr_keyword">new</strong> byte[4096];
<a class="jxr_linenumber" name="L288" href="#L288">288</a>
<a class="jxr_linenumber" name="L289" href="#L289">289</a> GZIPInputStream cin = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L290" href="#L290">290</a> FileOutputStream out = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L291" href="#L291">291</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L292" href="#L292">292</a> cin = <strong class="jxr_keyword">new</strong> GZIPInputStream(<strong class="jxr_keyword">new</strong> FileInputStream(gzip));
<a class="jxr_linenumber" name="L293" href="#L293">293</a> out = <strong class="jxr_keyword">new</strong> FileOutputStream(newfile);
<a class="jxr_linenumber" name="L294" href="#L294">294</a>
<a class="jxr_linenumber" name="L295" href="#L295">295</a> <strong class="jxr_keyword">int</strong> len;
<a class="jxr_linenumber" name="L296" href="#L296">296</a> <strong class="jxr_keyword">while</strong> ((len = cin.read(buffer)) &gt; 0) {
<a class="jxr_linenumber" name="L297" href="#L297">297</a> out.write(buffer, 0, len);
<a class="jxr_linenumber" name="L298" href="#L298">298</a> }
<a class="jxr_linenumber" name="L299" href="#L299">299</a> } <strong class="jxr_keyword">finally</strong> {
<a class="jxr_linenumber" name="L300" href="#L300">300</a> <strong class="jxr_keyword">if</strong> (cin != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L301" href="#L301">301</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L302" href="#L302">302</a> cin.close();
<a class="jxr_linenumber" name="L303" href="#L303">303</a> } <strong class="jxr_keyword">catch</strong> (IOException ex) {
<a class="jxr_linenumber" name="L304" href="#L304">304</a> LOGGER.trace(<span class="jxr_string">"ignore"</span>, ex);
<a class="jxr_linenumber" name="L305" href="#L305">305</a> }
<a class="jxr_linenumber" name="L306" href="#L306">306</a> }
<a class="jxr_linenumber" name="L307" href="#L307">307</a> <strong class="jxr_keyword">if</strong> (out != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L308" href="#L308">308</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L309" href="#L309">309</a> out.close();
<a class="jxr_linenumber" name="L310" href="#L310">310</a> } <strong class="jxr_keyword">catch</strong> (IOException ex) {
<a class="jxr_linenumber" name="L311" href="#L311">311</a> LOGGER.trace(<span class="jxr_string">"ignore"</span>, ex);
<a class="jxr_linenumber" name="L312" href="#L312">312</a> }
<a class="jxr_linenumber" name="L313" href="#L313">313</a> }
<a class="jxr_linenumber" name="L314" href="#L314">314</a> <strong class="jxr_keyword">if</strong> (gzip.isFile() &amp;&amp; !org.apache.commons.io.FileUtils.deleteQuietly(gzip)) {
<a class="jxr_linenumber" name="L315" href="#L315">315</a> LOGGER.debug(<span class="jxr_string">"Failed to delete temporary file when extracting 'gz' {}"</span>, gzip.toString());
<a class="jxr_linenumber" name="L316" href="#L316">316</a> gzip.deleteOnExit();
<a class="jxr_linenumber" name="L317" href="#L317">317</a> }
<a class="jxr_linenumber" name="L318" href="#L318">318</a> }
<a class="jxr_linenumber" name="L319" href="#L319">319</a> }
<a class="jxr_linenumber" name="L320" href="#L320">320</a> }
</pre>
<hr/>
<div id="footer">Copyright &#169; 2012&#x2013;2017 <a href="http://www.owasp.org">OWASP</a>. All rights reserved.</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink