📄 archiverecord.html
字号:
<!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=ISO-8859-1" /><title>ArchiveRecord xref</title><link type="text/css" rel="stylesheet" href="../../../stylesheet.css" /></head><body><pre><a name="1" href="#1">1</a> <em class="comment">/*<em class="comment"> $Id: ArchiveRecord.java,v 1.8 2006/08/31 16:51:41 stack-sf Exp $</em></em><a name="2" href="#2">2</a> <em class="comment"> *</em><a name="3" href="#3">3</a> <em class="comment"> * Created on August 21st, 2006</em><a name="4" href="#4">4</a> <em class="comment"> *</em><a name="5" href="#5">5</a> <em class="comment"> * Copyright (C) 2006 Internet Archive.</em><a name="6" href="#6">6</a> <em class="comment"> *</em><a name="7" href="#7">7</a> <em class="comment"> * This file is part of the Heritrix web crawler (crawler.archive.org).</em><a name="8" href="#8">8</a> <em class="comment"> *</em><a name="9" href="#9">9</a> <em class="comment"> * Heritrix is free software; you can redistribute it and/or modify</em><a name="10" href="#10">10</a> <em class="comment"> * it under the terms of the GNU Lesser Public License as published by</em><a name="11" href="#11">11</a> <em class="comment"> * the Free Software Foundation; either version 2.1 of the License, or</em><a name="12" href="#12">12</a> <em class="comment"> * any later version.</em><a name="13" href="#13">13</a> <em class="comment"> *</em><a name="14" href="#14">14</a> <em class="comment"> * Heritrix is distributed in the hope that it will be useful,</em><a name="15" href="#15">15</a> <em class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</em><a name="16" href="#16">16</a> <em class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</em><a name="17" href="#17">17</a> <em class="comment"> * GNU Lesser Public License for more details.</em><a name="18" href="#18">18</a> <em class="comment"> *</em><a name="19" href="#19">19</a> <em class="comment"> * You should have received a copy of the GNU Lesser Public License</em><a name="20" href="#20">20</a> <em class="comment"> * along with Heritrix; if not, write to the Free Software</em><a name="21" href="#21">21</a> <em class="comment"> * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</em><a name="22" href="#22">22</a> <em class="comment"> */</em><a name="23" href="#23">23</a> <strong>package</strong> <a href="../../../org/archive/io/package-summary.html">org.archive.io</a>;<a name="24" href="#24">24</a> <a name="25" href="#25">25</a> <strong>import</strong> java.io.IOException;<a name="26" href="#26">26</a> <strong>import</strong> java.io.InputStream;<a name="27" href="#27">27</a> <strong>import</strong> java.io.OutputStream;<a name="28" href="#28">28</a> <strong>import</strong> java.security.MessageDigest;<a name="29" href="#29">29</a> <strong>import</strong> java.security.NoSuchAlgorithmException;<a name="30" href="#30">30</a> <strong>import</strong> java.util.logging.Level;<a name="31" href="#31">31</a> <a name="32" href="#32">32</a> <strong>import</strong> org.archive.util.Base32;<a name="33" href="#33">33</a> <a name="34" href="#34">34</a> <em>/**<em>*</em></em><a name="35" href="#35">35</a> <em> * Archive file Record.</em><a name="36" href="#36">36</a> <em> * @author stack</em><a name="37" href="#37">37</a> <em> * @version $Date: 2006/08/31 16:51:41 $ $Version$</em><a name="38" href="#38">38</a> <em> */</em><a name="39" href="#39">39</a> <strong>public</strong> <strong>abstract</strong> <strong>class</strong> <a href="../../../org/archive/io/ArchiveRecord.html">ArchiveRecord</a> <strong>extends</strong> InputStream {<a name="40" href="#40">40</a> <a href="../../../org/archive/io/ArchiveRecordHeader.html">ArchiveRecordHeader</a> header = <strong>null</strong>;<a name="41" href="#41">41</a> <a name="42" href="#42">42</a> <em>/**<em>*</em></em><a name="43" href="#43">43</a> <em> * Stream to read this record from.</em><a name="44" href="#44">44</a> <em> *</em><a name="45" href="#45">45</a> <em> * Stream can only be read sequentially. Will only return this records'</em><a name="46" href="#46">46</a> <em> * content returning a -1 if you try to read beyond the end of the current</em><a name="47" href="#47">47</a> <em> * record.</em><a name="48" href="#48">48</a> <em> *</em><a name="49" href="#49">49</a> <em> * <p>Streams can be markable or not. If they are, we'll be able to roll</em><a name="50" href="#50">50</a> <em> * back when we've read too far. If not markable, assumption is that</em><a name="51" href="#51">51</a> <em> * the underlying stream is managing our not reading too much (This pertains</em><a name="52" href="#52">52</a> <em> * to the skipping over the end of the ARCRecord. See {@link #skip()}.</em><a name="53" href="#53">53</a> <em> */</em><a name="54" href="#54">54</a> InputStream in = <strong>null</strong>;<a name="55" href="#55">55</a> <a name="56" href="#56">56</a> <em>/**<em>*</em></em><a name="57" href="#57">57</a> <em> * Position w/i the Record content, within <code>in</code>.</em><a name="58" href="#58">58</a> <em> * This position is relative within this Record. Its not same as the</em><a name="59" href="#59">59</a> <em> * Archive file position.</em><a name="60" href="#60">60</a> <em> */</em><a name="61" href="#61">61</a> <strong>long</strong> position = 0;<a name="62" href="#62">62</a> <a name="63" href="#63">63</a> <em>/**<em>*</em></em><a name="64" href="#64">64</a> <em> * Set flag when we've reached the end-of-record.</em><a name="65" href="#65">65</a> <em> */</em><a name="66" href="#66">66</a> <strong>boolean</strong> eor = false;<a name="67" href="#67">67</a> <a name="68" href="#68">68</a> <em>/**<em>*</em></em><a name="69" href="#69">69</a> <em> * Compute digest on what we read and add to metadata when done.</em><a name="70" href="#70">70</a> <em> * </em><a name="71" href="#71">71</a> <em> * Currently hardcoded as sha-1. TODO: Remove when archive records</em><a name="72" href="#72">72</a> <em> * digest or else, add a facility that allows the arc reader to</em><a name="73" href="#73">73</a> <em> * compare the calculated digest to that which is recorded in</em><a name="74" href="#74">74</a> <em> * the arc.</em><a name="75" href="#75">75</a> <em> * </em><a name="76" href="#76">76</a> <em> * <p>Protected instead of private so subclasses can update and complete</em><a name="77" href="#77">77</a> <em> * the digest.</em><a name="78" href="#78">78</a> <em> */</em><a name="79" href="#79">79</a> <strong>protected</strong> MessageDigest digest = <strong>null</strong>;<a name="80" href="#80">80</a> <strong>private</strong> String digestStr = <strong>null</strong>;<a name="81" href="#81">81</a> <a name="82" href="#82">82</a> <strong>boolean</strong> strict = false;<a name="83" href="#83">83</a> <a name="84" href="#84">84</a> <strong>private</strong> <strong>int</strong> contentBegin = -1;<a name="85" href="#85">85</a> <a name="86" href="#86">86</a> <strong>private</strong> <a href="../../../org/archive/io/ArchiveRecord.html">ArchiveRecord</a>() {<a name="87" href="#87">87</a> <strong>super</strong>();<a name="88" href="#88">88</a> }<a name="89" href="#89">89</a> <a name="90" href="#90">90</a> <em>/**<em>*</em></em><a name="91" href="#91">91</a> <em> * Constructor.</em><a name="92" href="#92">92</a> <em> *</em><a name="93" href="#93">93</a> <em> * @param in Stream cue'd up to be at the start of the record this instance</em><a name="94" href="#94">94</a> <em> * is to represent.</em><a name="95" href="#95">95</a> <em> * @throws IOException</em><a name="96" href="#96">96</a> <em> */</em><a name="97" href="#97">97</a> <strong>public</strong> <a href="../../../org/archive/io/ArchiveRecord.html">ArchiveRecord</a>(InputStream in)<a name="98" href="#98">98</a> throws IOException {<a name="99" href="#99">99</a> <strong>this</strong>(in, <strong>null</strong>, 0, <strong>true</strong>, false);<a name="100" href="#100">100</a> }<a name="101" href="#101">101</a> <a name="102" href="#102">102</a> <em>/**<em>*</em></em><a name="103" href="#103">103</a> <em> * Constructor.</em><a name="104" href="#104">104</a> <em> *</em><a name="105" href="#105">105</a> <em> * @param in Stream cue'd up to be at the start of the record this instance</em><a name="106" href="#106">106</a> <em> * is to represent.</em><a name="107" href="#107">107</a> <em> * @param header Header data.</em><a name="108" href="#108">108</a> <em> * @throws IOException</em><a name="109" href="#109">109</a> <em> */</em><a name="110" href="#110">110</a> <strong>public</strong> <a href="../../../org/archive/io/ArchiveRecord.html">ArchiveRecord</a>(InputStream in, <a href="../../../org/archive/io/ArchiveRecordHeader.html">ArchiveRecordHeader</a> header)<a name="111" href="#111">111</a> throws IOException {<a name="112" href="#112">112</a> <strong>this</strong>(in, header, 0, <strong>true</strong>, false);<a name="113" href="#113">113</a> }<a name="114" href="#114">114</a> <a name="115" href="#115">115</a> <em>/**<em>*</em></em><a name="116" href="#116">116</a> <em> * Constructor.</em><a name="117" href="#117">117</a> <em> *</em><a name="118" href="#118">118</a> <em> * @param in Stream cue'd up to be at the start of the record this instance</em><a name="119" href="#119">119</a> <em> * is to represent.</em><a name="120" href="#120">120</a> <em> * @param header Header data.</em><a name="121" href="#121">121</a> <em> * @param bodyOffset Offset into the body. Usually 0.</em><a name="122" href="#122">122</a> <em> * @param digest True if we're to calculate digest for this record. Not</em><a name="123" href="#123">123</a> <em> * digesting saves about ~15% of cpu during an ARC parse.</em><a name="124" href="#124">124</a> <em> * @param strict Be strict parsing (Parsing stops if ARC inproperly</em><a name="125" href="#125">125</a> <em> * formatted).</em><a name="126" href="#126">126</a> <em> * @throws IOException</em><a name="127" href="#127">127</a> <em> */</em><a name="128" href="#128">128</a> <strong>public</strong> <a href="../../../org/archive/io/ArchiveRecord.html">ArchiveRecord</a>(InputStream in, <a href="../../../org/archive/io/ArchiveRecordHeader.html">ArchiveRecordHeader</a> header,<a name="129" href="#129">129</a> <strong>int</strong> bodyOffset, <strong>boolean</strong> digest, <strong>boolean</strong> strict) <a name="130" href="#130">130</a> throws IOException {<a name="131" href="#131">131</a> <strong>this</strong>.in = in;<a name="132" href="#132">132</a> <strong>this</strong>.header = header;<a name="133" href="#133">133</a> <strong>this</strong>.position = bodyOffset;<a name="134" href="#134">134</a> <strong>if</strong> (digest) {<a name="135" href="#135">135</a> <strong>try</strong> {<a name="136" href="#136">136</a> <strong>this</strong>.digest = MessageDigest.getInstance(<span class="string">"SHA1"</span>);<a name="137" href="#137">137</a> } <strong>catch</strong> (NoSuchAlgorithmException e) {<a name="138" href="#138">138</a> <em class="comment">// Convert to IOE because thats more amenable to callers</em><a name="139" href="#139">139</a> <em class="comment">// -- they are dealing with it anyways.</em><a name="140" href="#140">140</a> <strong>throw</strong> <strong>new</strong> IOException(e.getMessage());<a name="141" href="#141">141</a> }<a name="142" href="#142">142</a> }<a name="143" href="#143">143</a> <strong>this</strong>.strict = strict;<a name="144" href="#144">144</a> }<a name="145" href="#145">145</a> <a name="146" href="#146">146</a> <strong>public</strong> <strong>boolean</strong> markSupported() {<a name="147" href="#147">147</a> <strong>return</strong> false;<a name="148" href="#148">148</a> }<a name="149" href="#149">149</a> <a name="150" href="#150">150</a> <em>/**<em>*</em></em><a name="151" href="#151">151</a> <em> * @return Header data for this record.</em><a name="152" href="#152">152</a> <em> */</em><a name="153" href="#153">153</a> <strong>public</strong> <a href="../../../org/archive/io/ArchiveRecordHeader.html">ArchiveRecordHeader</a> getHeader() {<a name="154" href="#154">154</a> <strong>return</strong> <strong>this</strong>.header;<a name="155" href="#155">155</a> }<a name="156" href="#156">156</a> <a name="157" href="#157">157</a> <strong>protected</strong> <strong>void</strong> setHeader(<a href="../../../org/archive/io/ArchiveRecordHeader.html">ArchiveRecordHeader</a> header) {<a name="158" href="#158">158</a> <strong>this</strong>.header = header;<a name="159" href="#159">159</a> }<a name="160" href="#160">160</a> <a name="161" href="#161">161</a> <em>/**<em>*</em></em><a name="162" href="#162">162</a> <em> * Calling close on a record skips us past this record to the next record</em><a name="163" href="#163">163</a> <em> * in the stream.</em><a name="164" href="#164">164</a> <em> *</em><a name="165" href="#165">165</a> <em> * It does not actually close the stream. The underlying steam is probably</em><a name="166" href="#166">166</a> <em> * being used by the next arc record.</em><a name="167" href="#167">167</a> <em> *</em><a name="168" href="#168">168</a> <em> * @throws IOException</em><a name="169" href="#169">169</a> <em> */</em><a name="170" href="#170">170</a> <strong>public</strong> <strong>void</strong> close() throws IOException {<a name="171" href="#171">171</a> <strong>if</strong> (<strong>this</strong>.in != <strong>null</strong>) {<a name="172" href="#172">172</a> skip();<a name="173" href="#173">173</a> <strong>this</strong>.in = <strong>null</strong>;<a name="174" href="#174">174</a> <strong>if</strong> (<strong>this</strong>.digest != <strong>null</strong>) {<a name="175" href="#175">175</a> <strong>this</strong>.digestStr = Base32.encode(<strong>this</strong>.digest.digest());<a name="176" href="#176">176</a> }<a name="177" href="#177">177</a> }<a name="178" href="#178">178</a> }<a name="179" href="#179">179</a> <a name="180" href="#180">180</a> <em>/**<em>*</em></em><a name="181" href="#181">181</a> <em> * @return Next character in this Record content else -1 if at EOR.</em><a name="182" href="#182">182</a> <em> * @throws IOException</em><a name="183" href="#183">183</a> <em> */</em><a name="184" href="#184">184</a> <strong>public</strong> <strong>int</strong> read() throws IOException {<a name="185" href="#185">185</a> <strong>int</strong> c = -1;<a name="186" href="#186">186</a> <strong>if</strong> (available() > 0) {<a name="187" href="#187">187</a> c = <strong>this</strong>.in.read();⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -