📄 arcrecord.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=UTF-8" /><title>ARCRecord xref</title><link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" /></head><body><div id="overview"><a href="../../../../../apidocs/org/archive/io/arc/ARCRecord.html">View Javadoc</a></div><pre><a name="1" href="#1">1</a> <em class="comment">/*<em class="comment"> ARCRecord</em></em><a name="2" href="#2">2</a> <em class="comment"> *</em><a name="3" href="#3">3</a> <em class="comment"> * $Id: ARCRecord.java,v 1.34 2006/08/28 23:44:17 stack-sf Exp $</em><a name="4" href="#4">4</a> <em class="comment"> *</em><a name="5" href="#5">5</a> <em class="comment"> * Created on Jan 7, 2004</em><a name="6" href="#6">6</a> <em class="comment"> *</em><a name="7" href="#7">7</a> <em class="comment"> * Copyright (C) 2004 Internet Archive.</em><a name="8" href="#8">8</a> <em class="comment"> *</em><a name="9" href="#9">9</a> <em class="comment"> * This file is part of the Heritrix web crawler (crawler.archive.org).</em><a name="10" href="#10">10</a> <em class="comment"> *</em><a name="11" href="#11">11</a> <em class="comment"> * Heritrix is free software; you can redistribute it and/or modify</em><a name="12" href="#12">12</a> <em class="comment"> * it under the terms of the GNU Lesser Public License as published by</em><a name="13" href="#13">13</a> <em class="comment"> * the Free Software Foundation; either version 2.1 of the License, or</em><a name="14" href="#14">14</a> <em class="comment"> * any later version.</em><a name="15" href="#15">15</a> <em class="comment"> *</em><a name="16" href="#16">16</a> <em class="comment"> * Heritrix is distributed in the hope that it will be useful,</em><a name="17" href="#17">17</a> <em class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</em><a name="18" href="#18">18</a> <em class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</em><a name="19" href="#19">19</a> <em class="comment"> * GNU Lesser Public License for more details.</em><a name="20" href="#20">20</a> <em class="comment"> *</em><a name="21" href="#21">21</a> <em class="comment"> * You should have received a copy of the GNU Lesser Public License</em><a name="22" href="#22">22</a> <em class="comment"> * along with Heritrix; if not, write to the Free Software</em><a name="23" href="#23">23</a> <em class="comment"> * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</em><a name="24" href="#24">24</a> <em class="comment"> */</em><a name="25" href="#25">25</a> <strong>package</strong> <a href="../../../../org/archive/io/arc/package-summary.html">org.archive.io.arc</a>;<a name="26" href="#26">26</a> <a name="27" href="#27">27</a> <strong>import</strong> java.io.ByteArrayInputStream;<a name="28" href="#28">28</a> <strong>import</strong> java.io.ByteArrayOutputStream;<a name="29" href="#29">29</a> <strong>import</strong> java.io.IOException;<a name="30" href="#30">30</a> <strong>import</strong> java.io.InputStream;<a name="31" href="#31">31</a> <a name="32" href="#32">32</a> <strong>import</strong> org.apache.commons.httpclient.Header;<a name="33" href="#33">33</a> <strong>import</strong> org.apache.commons.httpclient.HttpParser;<a name="34" href="#34">34</a> <strong>import</strong> org.apache.commons.httpclient.StatusLine;<a name="35" href="#35">35</a> <strong>import</strong> org.apache.commons.httpclient.util.EncodingUtil;<a name="36" href="#36">36</a> <strong>import</strong> org.archive.io.ArchiveRecord;<a name="37" href="#37">37</a> <strong>import</strong> org.archive.io.ArchiveRecordHeader;<a name="38" href="#38">38</a> <a name="39" href="#39">39</a> <a name="40" href="#40">40</a> <em>/**<em>*</em></em><a name="41" href="#41">41</a> <em> * An ARC file record.</em><a name="42" href="#42">42</a> <em> * Does not compass the ARCRecord metadata line, just the record content.</em><a name="43" href="#43">43</a> <em> * @author stack</em><a name="44" href="#44">44</a> <em> */</em><a name="45" href="#45">45</a> <strong>public</strong> <strong>class</strong> <a href="../../../../org/archive/io/arc/ARCRecord.html">ARCRecord</a> <strong>extends</strong> <a href="../../../../org/archive/io/ArchiveRecord.html">ArchiveRecord</a> implements <a href="../../../../org/archive/io/arc/ARCConstants.html">ARCConstants</a> {<a name="46" href="#46">46</a> <em>/**<em>*</em></em><a name="47" href="#47">47</a> <em> * Http status line object.</em><a name="48" href="#48">48</a> <em> * </em><a name="49" href="#49">49</a> <em> * May be null if record is not http.</em><a name="50" href="#50">50</a> <em> */</em><a name="51" href="#51">51</a> <strong>private</strong> StatusLine httpStatus = <strong>null</strong>;<a name="52" href="#52">52</a> <a name="53" href="#53">53</a> <em>/**<em>*</em></em><a name="54" href="#54">54</a> <em> * Http header bytes.</em><a name="55" href="#55">55</a> <em> * </em><a name="56" href="#56">56</a> <em> * If non-null and bytes available, give out its contents before we</em><a name="57" href="#57">57</a> <em> * go back to the underlying stream.</em><a name="58" href="#58">58</a> <em> */</em><a name="59" href="#59">59</a> <strong>private</strong> InputStream httpHeaderStream = <strong>null</strong>;<a name="60" href="#60">60</a> <a name="61" href="#61">61</a> <em>/**<em>*</em></em><a name="62" href="#62">62</a> <em> * Http headers.</em><a name="63" href="#63">63</a> <em> * </em><a name="64" href="#64">64</a> <em> * Only populated after reading of headers.</em><a name="65" href="#65">65</a> <em> */</em><a name="66" href="#66">66</a> <strong>private</strong> Header [] httpHeaders = <strong>null</strong>;<a name="67" href="#67">67</a> <a name="68" href="#68">68</a> <a name="69" href="#69">69</a> <em>/**<em>*</em></em><a name="70" href="#70">70</a> <em> * Minimal http header length.</em><a name="71" href="#71">71</a> <em> * </em><a name="72" href="#72">72</a> <em> * I've seen in arcs content length of 1 with no </em><a name="73" href="#73">73</a> <em> * header.</em><a name="74" href="#74">74</a> <em> */</em><a name="75" href="#75">75</a> <strong>private</strong> <strong>static</strong> <strong>final</strong> <strong>long</strong> MIN_HTTP_HEADER_LENGTH =<a name="76" href="#76">76</a> <span class="string">"HTTP/1.1 200 OK\r\n"</span>.length();<a name="77" href="#77">77</a> <a name="78" href="#78">78</a> <em>/**<em>*</em></em><a name="79" href="#79">79</a> <em> * Constructor.</em><a name="80" href="#80">80</a> <em> *</em><a name="81" href="#81">81</a> <em> * @param in Stream cue'd up to be at the start of the record this instance</em><a name="82" href="#82">82</a> <em> * is to represent.</em><a name="83" href="#83">83</a> <em> * @param metaData Meta data.</em><a name="84" href="#84">84</a> <em> * @throws IOException</em><a name="85" href="#85">85</a> <em> */</em><a name="86" href="#86">86</a> <strong>public</strong> <a href="../../../../org/archive/io/arc/ARCRecord.html">ARCRecord</a>(InputStream in, <a href="../../../../org/archive/io/ArchiveRecordHeader.html">ArchiveRecordHeader</a> metaData)<a name="87" href="#87">87</a> throws IOException {<a name="88" href="#88">88</a> <strong>this</strong>(in, metaData, 0, <strong>true</strong>, false, <strong>true</strong>);<a name="89" href="#89">89</a> }<a name="90" href="#90">90</a> <a name="91" href="#91">91</a> <em>/**<em>*</em></em><a name="92" href="#92">92</a> <em> * Constructor.</em><a name="93" href="#93">93</a> <em> *</em><a name="94" href="#94">94</a> <em> * @param in Stream cue'd up to be at the start of the record this instance</em><a name="95" href="#95">95</a> <em> * is to represent.</em><a name="96" href="#96">96</a> <em> * @param metaData Meta data.</em><a name="97" href="#97">97</a> <em> * @param bodyOffset Offset into the body. Usually 0.</em><a name="98" href="#98">98</a> <em> * @param digest True if we're to calculate digest for this record. Not</em><a name="99" href="#99">99</a> <em> * digesting saves about ~15% of cpu during an ARC parse.</em><a name="100" href="#100">100</a> <em> * @param strict Be strict parsing (Parsing stops if ARC inproperly</em><a name="101" href="#101">101</a> <em> * formatted).</em><a name="102" href="#102">102</a> <em> * @param parseHttpHeaders True if we are to parse HTTP headers. Costs</em><a name="103" href="#103">103</a> <em> * about ~20% of CPU during an ARC parse.</em><a name="104" href="#104">104</a> <em> * @throws IOException</em><a name="105" href="#105">105</a> <em> */</em><a name="106" href="#106">106</a> <strong>public</strong> <a href="../../../../org/archive/io/arc/ARCRecord.html">ARCRecord</a>(InputStream in, <a href="../../../../org/archive/io/ArchiveRecordHeader.html">ArchiveRecordHeader</a> metaData,<a name="107" href="#107">107</a> <strong>int</strong> bodyOffset, <strong>boolean</strong> digest, <strong>boolean</strong> strict,<a name="108" href="#108">108</a> <strong>final</strong> <strong>boolean</strong> parseHttpHeaders) <a name="109" href="#109">109</a> throws IOException {<a name="110" href="#110">110</a> <strong>super</strong>(in, metaData, bodyOffset, digest, strict);<a name="111" href="#111">111</a> <strong>if</strong> (parseHttpHeaders) {<a name="112" href="#112">112</a> <strong>this</strong>.httpHeaderStream = readHttpHeader();<a name="113" href="#113">113</a> }<a name="114" href="#114">114</a> }<a name="115" href="#115">115</a> <a name="116" href="#116">116</a> <em>/**<em>*</em></em><a name="117" href="#117">117</a> <em> * Skip over the the http header if one present.</em><a name="118" href="#118">118</a> <em> * </em><a name="119" href="#119">119</a> <em> * Subsequent reads will get the body.</em><a name="120" href="#120">120</a> <em> * </em><a name="121" href="#121">121</a> <em> * <p>Calling this method in the midst of reading the header</em><a name="122" href="#122">122</a> <em> * will make for strange results. Otherwise, safe to call</em><a name="123" href="#123">123</a> <em> * at any time though before reading any of the arc record</em><a name="124" href="#124">124</a> <em> * content is only time that it makes sense.</em><a name="125" href="#125">125</a> <em> * </em><a name="126" href="#126">126</a> <em> * <p>After calling this method, you can call</em><a name="127" href="#127">127</a> <em> * {@link #getHttpHeaders()} to get the read http header.</em><a name="128" href="#128">128</a> <em> * </em><a name="129" href="#129">129</a> <em> * @throws IOException</em><a name="130" href="#130">130</a> <em> */</em><a name="131" href="#131">131</a> <strong>public</strong> <strong>void</strong> skipHttpHeader() throws IOException {<a name="132" href="#132">132</a> <strong>if</strong> (<strong>this</strong>.httpHeaderStream != <strong>null</strong>) {<a name="133" href="#133">133</a> <em class="comment">// Empty the httpHeaderStream</em><a name="134" href="#134">134</a> <strong>for</strong> (<strong>int</strong> available = <strong>this</strong>.httpHeaderStream.available();<a name="135" href="#135">135</a> <strong>this</strong>.httpHeaderStream != <strong>null</strong> &&<a name="136" href="#136">136</a> (available = <strong>this</strong>.httpHeaderStream.available()) > 0;) {<a name="137" href="#137">137</a> <em class="comment">// We should be in this loop once only we should only do this</em><a name="138" href="#138">138</a> <em class="comment">// buffer allocation once.</em><a name="139" href="#139">139</a> byte [] buffer = <strong>new</strong> byte[available];<a name="140" href="#140">140</a> <em class="comment">// The read nulls out httpHeaderStream when done with it so</em><a name="141" href="#141">141</a> <em class="comment">// need check for null in the loop control line.</em><a name="142" href="#142">142</a> read(buffer, 0, available);<a name="143" href="#143">143</a> }<a name="144" href="#144">144</a> }<a name="145" href="#145">145</a> }<a name="146" href="#146">146</a> <a name="147" href="#147">147</a> <em>/**<em>*</em></em><a name="148" href="#148">148</a> <em> * Read http header if present.</em><a name="149" href="#149">149</a> <em> * Technique borrowed from HttpClient HttpParse class.</em><a name="150" href="#150">150</a> <em> * @return ByteArrayInputStream with the http header in it or null if no</em><a name="151" href="#151">151</a> <em> * http header.</em><a name="152" href="#152">152</a> <em> * @throws IOException</em><a name="153" href="#153">153</a> <em> */</em><a name="154" href="#154">154</a> <strong>private</strong> InputStream readHttpHeader() throws IOException {<a name="155" href="#155">155</a> <em class="comment">// If judged a record that doesn't have an http header, return</em><a name="156" href="#156">156</a> <em class="comment">// immediately.</em><a name="157" href="#157">157</a> <strong>if</strong>(!getHeader().getUrl().startsWith(<span class="string">"http"</span>) ||<a name="158" href="#158">158</a> getHeader().getLength() <= MIN_HTTP_HEADER_LENGTH) {<a name="159" href="#159">159</a> <strong>return</strong> <strong>null</strong>;<a name="160" href="#160">160</a> }<a name="161" href="#161">161</a> byte [] statusBytes = HttpParser.readRawLine(getIn());<a name="162" href="#162">162</a> <strong>int</strong> eolCharCount = getEolCharsCount(statusBytes);<a name="163" href="#163">163</a> <strong>if</strong> (eolCharCount <= 0) {<a name="164" href="#164">164</a> <strong>throw</strong> <strong>new</strong> IOException(<span class="string">"Failed to read http status where one "</span> +<a name="165" href="#165">165</a> <span class="string">" was expected: "</span> + <strong>new</strong> String(statusBytes));<a name="166" href="#166">166</a> }<a name="167" href="#167">167</a> String statusLine = EncodingUtil.getString(statusBytes, 0,<a name="168" href="#168">168</a> statusBytes.length - eolCharCount, ARCConstants.DEFAULT_ENCODING);<a name="169" href="#169">169</a> <strong>if</strong> ((statusLine == <strong>null</strong>) ||⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -