📄 arcwriter.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>ARCWriter xref</title><link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" /></head><body><div id="overview"><a href="../../../../../apidocs/org/archive/io/arc/ARCWriter.html">View Javadoc</a></div><pre><a name="1" href="#1">1</a> <em class="comment">/*</em><a name="2" href="#2">2</a> <em class="comment"> * ARCWriter</em><a name="3" href="#3">3</a> <em class="comment"> *</em><a name="4" href="#4">4</a> <em class="comment"> * $Id: ARCWriter.java,v 1.54.2.1 2006/09/25 22:52:31 stack-sf Exp $</em><a name="5" href="#5">5</a> <em class="comment"> *</em><a name="6" href="#6">6</a> <em class="comment"> * Created on Jun 5, 2003</em><a name="7" href="#7">7</a> <em class="comment"> *</em><a name="8" href="#8">8</a> <em class="comment"> * Copyright (C) 2003 Internet Archive.</em><a name="9" href="#9">9</a> <em class="comment"> *</em><a name="10" href="#10">10</a> <em class="comment"> * This file is part of the Heritrix web crawler (crawler.archive.org).</em><a name="11" href="#11">11</a> <em class="comment"> *</em><a name="12" href="#12">12</a> <em class="comment"> * Heritrix is free software; you can redistribute it and/or modify</em><a name="13" href="#13">13</a> <em class="comment"> * it under the terms of the GNU Lesser Public License as published by</em><a name="14" href="#14">14</a> <em class="comment"> * the Free Software Foundation; either version 2.1 of the License, or</em><a name="15" href="#15">15</a> <em class="comment"> * any later version.</em><a name="16" href="#16">16</a> <em class="comment"> *</em><a name="17" href="#17">17</a> <em class="comment"> * Heritrix is distributed in the hope that it will be useful,</em><a name="18" href="#18">18</a> <em class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</em><a name="19" href="#19">19</a> <em class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</em><a name="20" href="#20">20</a> <em class="comment"> * GNU Lesser Public License for more details.</em><a name="21" href="#21">21</a> <em class="comment"> *</em><a name="22" href="#22">22</a> <em class="comment"> * You should have received a copy of the GNU Lesser Public License</em><a name="23" href="#23">23</a> <em class="comment"> * along with Heritrix; if not, write to the Free Software</em><a name="24" href="#24">24</a> <em class="comment"> * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</em><a name="25" href="#25">25</a> <em class="comment"> */</em><a name="26" href="#26">26</a> <strong>package</strong> <a href="../../../../org/archive/io/arc/package-summary.html">org.archive.io.arc</a>;<a name="27" href="#27">27</a> <a name="28" href="#28">28</a> <strong>import</strong> java.io.BufferedInputStream;<a name="29" href="#29">29</a> <strong>import</strong> java.io.ByteArrayOutputStream;<a name="30" href="#30">30</a> <strong>import</strong> java.io.File;<a name="31" href="#31">31</a> <strong>import</strong> java.io.FileInputStream;<a name="32" href="#32">32</a> <strong>import</strong> java.io.IOException;<a name="33" href="#33">33</a> <strong>import</strong> java.io.InputStream;<a name="34" href="#34">34</a> <strong>import</strong> java.io.PrintStream;<a name="35" href="#35">35</a> <strong>import</strong> java.io.UnsupportedEncodingException;<a name="36" href="#36">36</a> <strong>import</strong> java.util.Iterator;<a name="37" href="#37">37</a> <strong>import</strong> java.util.List;<a name="38" href="#38">38</a> <strong>import</strong> java.util.concurrent.atomic.AtomicInteger;<a name="39" href="#39">39</a> <strong>import</strong> java.util.logging.Logger;<a name="40" href="#40">40</a> <strong>import</strong> java.util.regex.Matcher;<a name="41" href="#41">41</a> <strong>import</strong> java.util.regex.Pattern;<a name="42" href="#42">42</a> <a name="43" href="#43">43</a> <strong>import</strong> org.archive.io.GzippedInputStream;<a name="44" href="#44">44</a> <strong>import</strong> org.archive.io.ReplayInputStream;<a name="45" href="#45">45</a> <strong>import</strong> org.archive.io.WriterPoolMember;<a name="46" href="#46">46</a> <strong>import</strong> org.archive.util.ArchiveUtils;<a name="47" href="#47">47</a> <strong>import</strong> org.archive.util.DevUtils;<a name="48" href="#48">48</a> <strong>import</strong> org.archive.util.MimetypeUtils;<a name="49" href="#49">49</a> <a name="50" href="#50">50</a> <a name="51" href="#51">51</a> <em>/**<em>*</em></em><a name="52" href="#52">52</a> <em> * Write ARC files.</em><a name="53" href="#53">53</a> <em> *</em><a name="54" href="#54">54</a> <em> * Assumption is that the caller is managing access to this ARCWriter ensuring</em><a name="55" href="#55">55</a> <em> * only one thread of control accessing this ARC file instance at any one time.</em><a name="56" href="#56">56</a> <em> *</em><a name="57" href="#57">57</a> <em> * <p>ARC files are described here:</em><a name="58" href="#58">58</a> <em> * <a href="<a href="http://www.archive.org/web/researcher/ArcFileFormat.php" target="alexandria_uri">http://www.archive.org/web/researcher/ArcFileFormat.php</a>">Arc</em><a name="59" href="#59">59</a> <em> * File Format</a>. This class does version 1 of the ARC file format. It also</em><a name="60" href="#60">60</a> <em> * writes version 1.1 which is version 1 with data stuffed into the body of the</em><a name="61" href="#61">61</a> <em> * first arc record in the file, the arc file meta record itself.</em><a name="62" href="#62">62</a> <em> *</em><a name="63" href="#63">63</a> <em> * <p>An ARC file is three lines of meta data followed by an optional 'body' and</em><a name="64" href="#64">64</a> <em> * then a couple of '\n' and then: record, '\n', record, '\n', record, etc.</em><a name="65" href="#65">65</a> <em> * If we are writing compressed ARC files, then each of the ARC file records is</em><a name="66" href="#66">66</a> <em> * individually gzipped and concatenated together to make up a single ARC file.</em><a name="67" href="#67">67</a> <em> * In GZIP terms, each ARC record is a GZIP <i>member</i> of a total gzip'd</em><a name="68" href="#68">68</a> <em> * file.</em><a name="69" href="#69">69</a> <em> *</em><a name="70" href="#70">70</a> <em> * <p>The GZIPping of the ARC file meta data is exceptional. It is GZIPped</em><a name="71" href="#71">71</a> <em> * w/ an extra GZIP header, a special Internet Archive (IA) extra header field</em><a name="72" href="#72">72</a> <em> * (e.g. FEXTRA is set in the GZIP header FLG field and an extra field is</em><a name="73" href="#73">73</a> <em> * appended to the GZIP header). The extra field has little in it but its</em><a name="74" href="#74">74</a> <em> * presence denotes this GZIP as an Internet Archive gzipped ARC. See RFC1952</em><a name="75" href="#75">75</a> <em> * to learn about the GZIP header structure.</em><a name="76" href="#76">76</a> <em> *</em><a name="77" href="#77">77</a> <em> * <p>This class then does its GZIPping in the following fashion. Each GZIP</em><a name="78" href="#78">78</a> <em> * member is written w/ a new instance of GZIPOutputStream -- actually</em><a name="79" href="#79">79</a> <em> * ARCWriterGZIPOututStream so we can get access to the underlying stream.</em><a name="80" href="#80">80</a> <em> * The underlying stream stays open across GZIPoutputStream instantiations.</em><a name="81" href="#81">81</a> <em> * For the 'special' GZIPing of the ARC file meta data, we cheat by catching the</em><a name="82" href="#82">82</a> <em> * GZIPOutputStream output into a byte array, manipulating it adding the</em><a name="83" href="#83">83</a> <em> * IA GZIP header, before writing to the stream.</em><a name="84" href="#84">84</a> <em> *</em><a name="85" href="#85">85</a> <em> * <p>I tried writing a resettable GZIPOutputStream and could make it work w/</em><a name="86" href="#86">86</a> <em> * the SUN JDK but the IBM JDK threw NPE inside in the deflate.reset -- its zlib</em><a name="87" href="#87">87</a> <em> * native call doesn't seem to like the notion of resetting -- so I gave up on</em><a name="88" href="#88">88</a> <em> * it.</em><a name="89" href="#89">89</a> <em> *</em><a name="90" href="#90">90</a> <em> * <p>Because of such as the above and troubles with GZIPInputStream, we should</em><a name="91" href="#91">91</a> <em> * write our own GZIP*Streams, ones that resettable and consious of gzip</em><a name="92" href="#92">92</a> <em> * members.</em><a name="93" href="#93">93</a> <em> *</em><a name="94" href="#94">94</a> <em> * <p>This class will write until we hit >= maxSize. The check is done at</em><a name="95" href="#95">95</a> <em> * record boundary. Records do not span ARC files. We will then close current</em><a name="96" href="#96">96</a> <em> * file and open another and then continue writing.</em><a name="97" href="#97">97</a> <em> *</em><a name="98" href="#98">98</a> <em> * <p><b>TESTING: </b>Here is how to test that produced ARC files are good</em><a name="99" href="#99">99</a> <em> * using the</em><a name="100" href="#100">100</a> <em> * <a href="<a href="http://www.archive.org/web/researcher/tool_documentation.php" target="alexandria_uri">http://www.archive.org/web/researcher/tool_documentation.php</a>">alexa</em><a name="101" href="#101">101</a> <em> * ARC c-tools</a>:</em><a name="102" href="#102">102</a> <em> * <pre></em><a name="103" href="#103">103</a> <em> * % av_procarc hx20040109230030-0.arc.gz | av_ziparc > \</em><a name="104" href="#104">104</a> <em> * /tmp/hx20040109230030-0.dat.gz</em><a name="105" href="#105">105</a> <em> * % av_ripdat /tmp/hx20040109230030-0.dat.gz > /tmp/hx20040109230030-0.cdx</em><a name="106" href="#106">106</a> <em> * </pre></em><a name="107" href="#107">107</a> <em> * Examine the produced cdx file to make sure it makes sense. Search</em><a name="108" href="#108">108</a> <em> * for 'no-type 0'. If found, then we're opening a gzip record w/o data to</em><a name="109" href="#109">109</a> <em> * write. This is bad.</em><a name="110" href="#110">110</a> <em> *</em><a name="111" href="#111">111</a> <em> * <p>You can also do <code>gzip -t FILENAME</code> and it will tell you if the</em><a name="112" href="#112">112</a> <em> * ARC makes sense to GZIP.</em><a name="113" href="#113">113</a> <em> * </em><a name="114" href="#114">114</a> <em> * <p>While being written, ARCs have a '.open' suffix appended.</em><a name="115" href="#115">115</a> <em> *</em><a name="116" href="#116">116</a> <em> * @author stack</em><a name="117" href="#117">117</a> <em> */</em><a name="118" href="#118">118</a> <strong>public</strong> <strong>class</strong> <a href="../../../../org/archive/io/arc/ARCWriter.html">ARCWriter</a> <strong>extends</strong> <a href="../../../../org/archive/io/WriterPoolMember.html">WriterPoolMember</a> implements <a href="../../../../org/archive/io/arc/ARCConstants.html">ARCConstants</a> {<a name="119" href="#119">119</a> <strong>private</strong> <strong>static</strong> <strong>final</strong> Logger logger =<a name="120" href="#120">120</a> Logger.getLogger(ARCWriter.<strong>class</strong>.getName());<a name="121" href="#121">121</a> <a name="122" href="#122">122</a> <em>/**<em>*</em></em><a name="123" href="#123">123</a> <em> * Metadata line pattern.</em><a name="124" href="#124">124</a> <em> */</em><a name="125" href="#125">125</a> <strong>private</strong> <strong>static</strong> <strong>final</strong> Pattern METADATA_LINE_PATTERN =<a name="126" href="#126">126</a> Pattern.compile(<span class="string">"^//S+ //S+ //S+ //S+ //S+("</span> + LINE_SEPARATOR + <span class="string">"?)$"</span>);<a name="127" href="#127">127</a> <a name="128" href="#128">128</a> <em>/**<em>*</em></em><a name="129" href="#129">129</a> <em> * Buffer to reuse writing streams.</em><a name="130" href="#130">130</a> <em> */</em><a name="131" href="#131">131</a> <strong>private</strong> <strong>final</strong> byte [] readbuffer = <strong>new</strong> byte[4 * 1024];<a name="132" href="#132">132</a> <a name="133" href="#133">133</a> <strong>private</strong> List metadata = <strong>null</strong>;<a name="134" href="#134">134</a> <a name="135" href="#135">135</a> <a name="136" href="#136">136</a> <em>/**<em>*</em></em><a name="137" href="#137">137</a> <em> * Constructor.</em><a name="138" href="#138">138</a> <em> * Takes a stream. Use with caution. There is no upperbound check on size.</em><a name="139" href="#139">139</a> <em> * Will just keep writing.</em><a name="140" href="#140">140</a> <em> * </em><a name="141" href="#141">141</a> <em> * @param serialNo used to generate unique file name sequences</em><a name="142" href="#142">142</a> <em> * @param out Where to write.</em><a name="143" href="#143">143</a> <em> * @param arc File the <code>out</code> is connected to.</em><a name="144" href="#144">144</a> <em> * @param cmprs Compress the content written.</em><a name="145" href="#145">145</a> <em> * @param metadata File meta data. Can be null. Is list of File and/or</em><a name="146" href="#146">146</a> <em> * String objects.</em><a name="147" href="#147">147</a> <em> * @param a14DigitDate If null, we'll write current time.</em><a name="148" href="#148">148</a> <em> * @throws IOException</em><a name="149" href="#149">149</a> <em> */</em><a name="150" href="#150">150</a> <strong>public</strong> <a href="../../../../org/archive/io/arc/ARCWriter.html">ARCWriter</a>(<strong>final</strong> AtomicInteger serialNo, <strong>final</strong> PrintStream out,<a name="151" href="#151">151</a> <strong>final</strong> File arc, <strong>final</strong> <strong>boolean</strong> cmprs, String a14DigitDate,<a name="152" href="#152">152</a> <strong>final</strong> List metadata)<a name="153" href="#153">153</a> throws IOException {<a name="154" href="#154">154</a> <strong>super</strong>(serialNo, out, arc, cmprs, a14DigitDate);<a name="155" href="#155">155</a> <strong>this</strong>.metadata = metadata;<a name="156" href="#156">156</a> writeFirstRecord(a14DigitDate);<a name="157" href="#157">157</a> }<a name="158" href="#158">158</a> <a name="159" href="#159">159</a> <em>/**<em>*</em></em>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -