Google Git
Sign in
apache / velocity-site / 89c3a15cf30ab2c0dbdf8253ed5c2eb24d9b1e21 / . / engine / 1.6.2 / xref / org / apache / velocity / runtime / resource / loader / FileResourceLoader.html
blob: d65dd3c9c389557635d3ad5ddfbd77419f3322d5 [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=ISO-8859-1" />
<title>FileResourceLoader xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../apidocs/org/apache/velocity/runtime/resource/loader/FileResourceLoader.html">View Javadoc</a></div><pre>
<a name="1" href="#1">1</a> <strong class="jxr_keyword">package</strong> org.apache.velocity.runtime.resource.loader;
<a name="2" href="#2">2</a>
<a name="3" href="#3">3</a> <em class="jxr_comment">/*</em>
<a name="4" href="#4">4</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
<a name="5" href="#5">5</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em>
<a name="6" href="#6">6</a> <em class="jxr_comment"> * distributed with this work for additional information</em>
<a name="7" href="#7">7</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em>
<a name="8" href="#8">8</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em>
<a name="9" href="#9">9</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em>
<a name="10" href="#10">10</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em>
<a name="11" href="#11">11</a> <em class="jxr_comment"> *</em>
<a name="12" href="#12">12</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a name="13" href="#13">13</a> <em class="jxr_comment"> *</em>
<a name="14" href="#14">14</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em>
<a name="15" href="#15">15</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em>
<a name="16" href="#16">16</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
<a name="17" href="#17">17</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em>
<a name="18" href="#18">18</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em>
<a name="19" href="#19">19</a> <em class="jxr_comment"> * under the License.</em>
<a name="20" href="#20">20</a> <em class="jxr_comment"> */</em>
<a name="21" href="#21">21</a>
<a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> java.io.BufferedInputStream;
<a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> java.io.File;
<a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> java.io.FileInputStream;
<a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> java.io.FileNotFoundException;
<a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> java.io.IOException;
<a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> java.io.InputStream;
<a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> java.util.ArrayList;
<a name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> java.util.Collections;
<a name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> java.util.HashMap;
<a name="31" href="#31">31</a> <strong class="jxr_keyword">import</strong> java.util.List;
<a name="32" href="#32">32</a> <strong class="jxr_keyword">import</strong> java.util.Map;
<a name="33" href="#33">33</a>
<a name="34" href="#34">34</a> <strong class="jxr_keyword">import</strong> org.apache.commons.collections.ExtendedProperties;
<a name="35" href="#35">35</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.exception.ResourceNotFoundException;
<a name="36" href="#36">36</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.exception.VelocityException;
<a name="37" href="#37">37</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.io.UnicodeInputStream;
<a name="38" href="#38">38</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.runtime.resource.Resource;
<a name="39" href="#39">39</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.util.StringUtils;
<a name="40" href="#40">40</a>
<a name="41" href="#41">41</a> <em class="jxr_javadoccomment">/**</em>
<a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * A loader for templates stored on the file system. Treats the template</em>
<a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * as relative to the configured root path. If the root path is empty</em>
<a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * treats the template name as an absolute path.</em>
<a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> *</em>
<a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * @author &lt;a href="<a href="mailto:wglass@forio.com" target="alexandria_uri">mailto:wglass@forio.com</a>"&gt;Will Glass-Husain&lt;/a&gt;</em>
<a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * @author &lt;a href="<a href="mailto:mailmur@yahoo.com" target="alexandria_uri">mailto:mailmur@yahoo.com</a>"&gt;Aki Nieminen&lt;/a&gt;</em>
<a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * @author &lt;a href="<a href="mailto:jvanzyl@apache.org" target="alexandria_uri">mailto:jvanzyl@apache.org</a>"&gt;Jason van Zyl&lt;/a&gt;</em>
<a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * @version $Id: FileResourceLoader.java 743617 2009-02-12 04:42:48Z nbubna $</em>
<a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> */</em>
<a name="51" href="#51">51</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/velocity/runtime/resource/loader/FileResourceLoader.html">FileResourceLoader</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../../org/apache/velocity/runtime/resource/loader/ResourceLoader.html">ResourceLoader</a>
<a name="52" href="#52">52</a> {
<a name="53" href="#53">53</a> <em class="jxr_javadoccomment">/**</em>
<a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * The paths to search for templates.</em>
<a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> */</em>
<a name="56" href="#56">56</a> <strong class="jxr_keyword">private</strong> List paths = <strong class="jxr_keyword">new</strong> ArrayList();
<a name="57" href="#57">57</a>
<a name="58" href="#58">58</a> <em class="jxr_javadoccomment">/**</em>
<a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * Used to map the path that a template was found on</em>
<a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> * so that we can properly check the modification</em>
<a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * times of the files. This is synchronizedMap</em>
<a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * instance.</em>
<a name="63" href="#63">63</a> <em class="jxr_javadoccomment"> */</em>
<a name="64" href="#64">64</a> <strong class="jxr_keyword">private</strong> Map templatePaths = Collections.synchronizedMap(<strong class="jxr_keyword">new</strong> HashMap());
<a name="65" href="#65">65</a>
<a name="66" href="#66">66</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Shall we inspect unicode files to see what encoding they contain?. */</em>
<a name="67" href="#67">67</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> unicode = false;
<a name="68" href="#68">68</a>
<a name="69" href="#69">69</a> <em class="jxr_javadoccomment">/**</em>
<a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> * @see org.apache.velocity.runtime.resource.loader.ResourceLoader#init(org.apache.commons.collections.ExtendedProperties)</em>
<a name="71" href="#71">71</a> <em class="jxr_javadoccomment"> */</em>
<a name="72" href="#72">72</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> init( ExtendedProperties configuration)
<a name="73" href="#73">73</a> {
<a name="74" href="#74">74</a> <strong class="jxr_keyword">if</strong> (log.isTraceEnabled())
<a name="75" href="#75">75</a> {
<a name="76" href="#76">76</a> log.trace(<span class="jxr_string">"FileResourceLoader : initialization starting."</span>);
<a name="77" href="#77">77</a> }
<a name="78" href="#78">78</a>
<a name="79" href="#79">79</a> paths.addAll( configuration.getVector(<span class="jxr_string">"path"</span>) );
<a name="80" href="#80">80</a>
<a name="81" href="#81">81</a> <em class="jxr_comment">// unicode files may have a BOM marker at the start, but Java</em>
<a name="82" href="#82">82</a> <em class="jxr_comment">// has problems recognizing the UTF-8 bom. Enabling unicode will</em>
<a name="83" href="#83">83</a> <em class="jxr_comment">// recognize all unicode boms.</em>
<a name="84" href="#84">84</a> unicode = configuration.getBoolean(<span class="jxr_string">"unicode"</span>, false);
<a name="85" href="#85">85</a>
<a name="86" href="#86">86</a> <strong class="jxr_keyword">if</strong> (log.isDebugEnabled())
<a name="87" href="#87">87</a> {
<a name="88" href="#88">88</a> log.debug(<span class="jxr_string">"Do unicode file recognition: "</span> + unicode);
<a name="89" href="#89">89</a> }
<a name="90" href="#90">90</a>
<a name="91" href="#91">91</a> <strong class="jxr_keyword">if</strong> (log.isDebugEnabled())
<a name="92" href="#92">92</a> {
<a name="93" href="#93">93</a> <em class="jxr_comment">// trim spaces from all paths</em>
<a name="94" href="#94">94</a> StringUtils.trimStrings(paths);
<a name="95" href="#95">95</a>
<a name="96" href="#96">96</a> <em class="jxr_comment">// this section lets tell people what paths we will be using</em>
<a name="97" href="#97">97</a> <strong class="jxr_keyword">int</strong> sz = paths.size();
<a name="98" href="#98">98</a> <strong class="jxr_keyword">for</strong>( <strong class="jxr_keyword">int</strong> i=0; i &lt; sz; i++)
<a name="99" href="#99">99</a> {
<a name="100" href="#100">100</a> log.debug(<span class="jxr_string">"FileResourceLoader : adding path '"</span> + (String) paths.get(i) + <span class="jxr_string">"'"</span>);
<a name="101" href="#101">101</a> }
<a name="102" href="#102">102</a> log.trace(<span class="jxr_string">"FileResourceLoader : initialization complete."</span>);
<a name="103" href="#103">103</a> }
<a name="104" href="#104">104</a> }
<a name="105" href="#105">105</a>
<a name="106" href="#106">106</a> <em class="jxr_javadoccomment">/**</em>
<a name="107" href="#107">107</a> <em class="jxr_javadoccomment"> * Get an InputStream so that the Runtime can build a</em>
<a name="108" href="#108">108</a> <em class="jxr_javadoccomment"> * template with it.</em>
<a name="109" href="#109">109</a> <em class="jxr_javadoccomment"> *</em>
<a name="110" href="#110">110</a> <em class="jxr_javadoccomment"> * @param templateName name of template to get</em>
<a name="111" href="#111">111</a> <em class="jxr_javadoccomment"> * @return InputStream containing the template</em>
<a name="112" href="#112">112</a> <em class="jxr_javadoccomment"> * @throws ResourceNotFoundException if template not found</em>
<a name="113" href="#113">113</a> <em class="jxr_javadoccomment"> * in the file template path.</em>
<a name="114" href="#114">114</a> <em class="jxr_javadoccomment"> */</em>
<a name="115" href="#115">115</a> <strong class="jxr_keyword">public</strong> InputStream getResourceStream(String templateName)
<a name="116" href="#116">116</a> <strong class="jxr_keyword">throws</strong> <a href="../../../../../../org/apache/velocity/exception/ResourceNotFoundException.html">ResourceNotFoundException</a>
<a name="117" href="#117">117</a> {
<a name="118" href="#118">118</a> <em class="jxr_comment">/*</em>
<a name="119" href="#119">119</a> <em class="jxr_comment"> * Make sure we have a valid templateName.</em>
<a name="120" href="#120">120</a> <em class="jxr_comment"> */</em>
<a name="121" href="#121">121</a> <strong class="jxr_keyword">if</strong> (org.apache.commons.lang.StringUtils.isEmpty(templateName))
<a name="122" href="#122">122</a> {
<a name="123" href="#123">123</a> <em class="jxr_comment">/*</em>
<a name="124" href="#124">124</a> <em class="jxr_comment"> * If we don't get a properly formed templateName then</em>
<a name="125" href="#125">125</a> <em class="jxr_comment"> * there's not much we can do. So we'll forget about</em>
<a name="126" href="#126">126</a> <em class="jxr_comment"> * trying to search any more paths for the template.</em>
<a name="127" href="#127">127</a> <em class="jxr_comment"> */</em>
<a name="128" href="#128">128</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/velocity/exception/ResourceNotFoundException.html">ResourceNotFoundException</a>(
<a name="129" href="#129">129</a> <span class="jxr_string">"Need to specify a file name or file path!"</span>);
<a name="130" href="#130">130</a> }
<a name="131" href="#131">131</a>
<a name="132" href="#132">132</a> String template = StringUtils.normalizePath(templateName);
<a name="133" href="#133">133</a> <strong class="jxr_keyword">if</strong> ( template == <strong class="jxr_keyword">null</strong> || template.length() == 0 )
<a name="134" href="#134">134</a> {
<a name="135" href="#135">135</a> String msg = <span class="jxr_string">"File resource error : argument "</span> + template +
<a name="136" href="#136">136</a> <span class="jxr_string">" contains .. and may be trying to access "</span> +
<a name="137" href="#137">137</a> <span class="jxr_string">"content outside of template root. Rejected."</span>;
<a name="138" href="#138">138</a>
<a name="139" href="#139">139</a> log.error(<span class="jxr_string">"FileResourceLoader : "</span> + msg);
<a name="140" href="#140">140</a>
<a name="141" href="#141">141</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/velocity/exception/ResourceNotFoundException.html">ResourceNotFoundException</a> ( msg );
<a name="142" href="#142">142</a> }
<a name="143" href="#143">143</a>
<a name="144" href="#144">144</a> <strong class="jxr_keyword">int</strong> size = paths.size();
<a name="145" href="#145">145</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i &lt; size; i++)
<a name="146" href="#146">146</a> {
<a name="147" href="#147">147</a> String path = (String) paths.get(i);
<a name="148" href="#148">148</a> InputStream inputStream = <strong class="jxr_keyword">null</strong>;
<a name="149" href="#149">149</a>
<a name="150" href="#150">150</a> <strong class="jxr_keyword">try</strong>
<a name="151" href="#151">151</a> {
<a name="152" href="#152">152</a> inputStream = findTemplate(path, template);
<a name="153" href="#153">153</a> }
<a name="154" href="#154">154</a> <strong class="jxr_keyword">catch</strong> (IOException ioe)
<a name="155" href="#155">155</a> {
<a name="156" href="#156">156</a> String msg = <span class="jxr_string">"Exception while loading Template "</span> + template;
<a name="157" href="#157">157</a> log.error(msg, ioe);
<a name="158" href="#158">158</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/velocity/exception/VelocityException.html">VelocityException</a>(msg, ioe);
<a name="159" href="#159">159</a> }
<a name="160" href="#160">160</a>
<a name="161" href="#161">161</a> <strong class="jxr_keyword">if</strong> (inputStream != <strong class="jxr_keyword">null</strong>)
<a name="162" href="#162">162</a> {
<a name="163" href="#163">163</a> <em class="jxr_comment">/*</em>
<a name="164" href="#164">164</a> <em class="jxr_comment"> * Store the path that this template came</em>
<a name="165" href="#165">165</a> <em class="jxr_comment"> * from so that we can check its modification</em>
<a name="166" href="#166">166</a> <em class="jxr_comment"> * time.</em>
<a name="167" href="#167">167</a> <em class="jxr_comment"> */</em>
<a name="168" href="#168">168</a> templatePaths.put(templateName, path);
<a name="169" href="#169">169</a> <strong class="jxr_keyword">return</strong> inputStream;
<a name="170" href="#170">170</a> }
<a name="171" href="#171">171</a> }
<a name="172" href="#172">172</a>
<a name="173" href="#173">173</a> <em class="jxr_comment">/*</em>
<a name="174" href="#174">174</a> <em class="jxr_comment"> * We have now searched all the paths for</em>
<a name="175" href="#175">175</a> <em class="jxr_comment"> * templates and we didn't find anything so</em>
<a name="176" href="#176">176</a> <em class="jxr_comment"> * throw an exception.</em>
<a name="177" href="#177">177</a> <em class="jxr_comment"> */</em>
<a name="178" href="#178">178</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/velocity/exception/ResourceNotFoundException.html">ResourceNotFoundException</a>(<span class="jxr_string">"FileResourceLoader : cannot find "</span> + template);
<a name="179" href="#179">179</a> }
<a name="180" href="#180">180</a>
<a name="181" href="#181">181</a> <em class="jxr_javadoccomment">/**</em>
<a name="182" href="#182">182</a> <em class="jxr_javadoccomment"> * Overrides superclass for better performance.</em>
<a name="183" href="#183">183</a> <em class="jxr_javadoccomment"> * @since 1.6</em>
<a name="184" href="#184">184</a> <em class="jxr_javadoccomment"> */</em>
<a name="185" href="#185">185</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> resourceExists(String name)
<a name="186" href="#186">186</a> {
<a name="187" href="#187">187</a> <strong class="jxr_keyword">if</strong> (name == <strong class="jxr_keyword">null</strong>)
<a name="188" href="#188">188</a> {
<a name="189" href="#189">189</a> <strong class="jxr_keyword">return</strong> false;
<a name="190" href="#190">190</a> }
<a name="191" href="#191">191</a> name = StringUtils.normalizePath(name);
<a name="192" href="#192">192</a> <strong class="jxr_keyword">if</strong> (name == <strong class="jxr_keyword">null</strong> || name.length() == 0)
<a name="193" href="#193">193</a> {
<a name="194" href="#194">194</a> <strong class="jxr_keyword">return</strong> false;
<a name="195" href="#195">195</a> }
<a name="196" href="#196">196</a>
<a name="197" href="#197">197</a> <strong class="jxr_keyword">int</strong> size = paths.size();
<a name="198" href="#198">198</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i &lt; size; i++)
<a name="199" href="#199">199</a> {
<a name="200" href="#200">200</a> String path = (String)paths.get(i);
<a name="201" href="#201">201</a> <strong class="jxr_keyword">try</strong>
<a name="202" href="#202">202</a> {
<a name="203" href="#203">203</a> File file = getFile(path, name);
<a name="204" href="#204">204</a> <strong class="jxr_keyword">if</strong> (file.canRead())
<a name="205" href="#205">205</a> {
<a name="206" href="#206">206</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
<a name="207" href="#207">207</a> }
<a name="208" href="#208">208</a> }
<a name="209" href="#209">209</a> <strong class="jxr_keyword">catch</strong> (Exception ioe)
<a name="210" href="#210">210</a> {
<a name="211" href="#211">211</a> String msg = <span class="jxr_string">"Exception while checking for template "</span> + name;
<a name="212" href="#212">212</a> log.debug(msg, ioe);
<a name="213" href="#213">213</a> }
<a name="214" href="#214">214</a> }
<a name="215" href="#215">215</a> <strong class="jxr_keyword">return</strong> false;
<a name="216" href="#216">216</a> }
<a name="217" href="#217">217</a>
<a name="218" href="#218">218</a> <em class="jxr_javadoccomment">/**</em>
<a name="219" href="#219">219</a> <em class="jxr_javadoccomment"> * Try to find a template given a normalized path.</em>
<a name="220" href="#220">220</a> <em class="jxr_javadoccomment"> *</em>
<a name="221" href="#221">221</a> <em class="jxr_javadoccomment"> * @param path a normalized path</em>
<a name="222" href="#222">222</a> <em class="jxr_javadoccomment"> * @param template name of template to find</em>
<a name="223" href="#223">223</a> <em class="jxr_javadoccomment"> * @return InputStream input stream that will be parsed</em>
<a name="224" href="#224">224</a> <em class="jxr_javadoccomment"> *</em>
<a name="225" href="#225">225</a> <em class="jxr_javadoccomment"> */</em>
<a name="226" href="#226">226</a> <strong class="jxr_keyword">private</strong> InputStream findTemplate(<strong class="jxr_keyword">final</strong> String path, <strong class="jxr_keyword">final</strong> String template)
<a name="227" href="#227">227</a> <strong class="jxr_keyword">throws</strong> IOException
<a name="228" href="#228">228</a> {
<a name="229" href="#229">229</a> <strong class="jxr_keyword">try</strong>
<a name="230" href="#230">230</a> {
<a name="231" href="#231">231</a> File file = getFile(path,template);
<a name="232" href="#232">232</a>
<a name="233" href="#233">233</a> <strong class="jxr_keyword">if</strong> (file.canRead())
<a name="234" href="#234">234</a> {
<a name="235" href="#235">235</a> FileInputStream fis = <strong class="jxr_keyword">null</strong>;
<a name="236" href="#236">236</a> <strong class="jxr_keyword">try</strong>
<a name="237" href="#237">237</a> {
<a name="238" href="#238">238</a> fis = <strong class="jxr_keyword">new</strong> FileInputStream(file.getAbsolutePath());
<a name="239" href="#239">239</a>
<a name="240" href="#240">240</a> <strong class="jxr_keyword">if</strong> (unicode)
<a name="241" href="#241">241</a> {
<a name="242" href="#242">242</a> <a href="../../../../../../org/apache/velocity/io/UnicodeInputStream.html">UnicodeInputStream</a> uis = <strong class="jxr_keyword">null</strong>;
<a name="243" href="#243">243</a>
<a name="244" href="#244">244</a> <strong class="jxr_keyword">try</strong>
<a name="245" href="#245">245</a> {
<a name="246" href="#246">246</a> uis = <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/velocity/io/UnicodeInputStream.html">UnicodeInputStream</a>(fis, <strong class="jxr_keyword">true</strong>);
<a name="247" href="#247">247</a>
<a name="248" href="#248">248</a> <strong class="jxr_keyword">if</strong> (log.isDebugEnabled())
<a name="249" href="#249">249</a> {
<a name="250" href="#250">250</a> log.debug(<span class="jxr_string">"File Encoding for "</span> + file + <span class="jxr_string">" is: "</span> + uis.getEncodingFromStream());
<a name="251" href="#251">251</a> }
<a name="252" href="#252">252</a>
<a name="253" href="#253">253</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> BufferedInputStream(uis);
<a name="254" href="#254">254</a> }
<a name="255" href="#255">255</a> <strong class="jxr_keyword">catch</strong>(IOException e)
<a name="256" href="#256">256</a> {
<a name="257" href="#257">257</a> closeQuiet(uis);
<a name="258" href="#258">258</a> <strong class="jxr_keyword">throw</strong> e;
<a name="259" href="#259">259</a> }
<a name="260" href="#260">260</a> }
<a name="261" href="#261">261</a> <strong class="jxr_keyword">else</strong>
<a name="262" href="#262">262</a> {
<a name="263" href="#263">263</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> BufferedInputStream(fis);
<a name="264" href="#264">264</a> }
<a name="265" href="#265">265</a> }
<a name="266" href="#266">266</a> <strong class="jxr_keyword">catch</strong> (IOException e)
<a name="267" href="#267">267</a> {
<a name="268" href="#268">268</a> closeQuiet(fis);
<a name="269" href="#269">269</a> <strong class="jxr_keyword">throw</strong> e;
<a name="270" href="#270">270</a> }
<a name="271" href="#271">271</a> }
<a name="272" href="#272">272</a> <strong class="jxr_keyword">else</strong>
<a name="273" href="#273">273</a> {
<a name="274" href="#274">274</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a name="275" href="#275">275</a> }
<a name="276" href="#276">276</a> }
<a name="277" href="#277">277</a> <strong class="jxr_keyword">catch</strong>(FileNotFoundException fnfe)
<a name="278" href="#278">278</a> {
<a name="279" href="#279">279</a> <em class="jxr_comment">/*</em>
<a name="280" href="#280">280</a> <em class="jxr_comment"> * log and convert to a general Velocity ResourceNotFoundException</em>
<a name="281" href="#281">281</a> <em class="jxr_comment"> */</em>
<a name="282" href="#282">282</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a name="283" href="#283">283</a> }
<a name="284" href="#284">284</a> }
<a name="285" href="#285">285</a>
<a name="286" href="#286">286</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> closeQuiet(<strong class="jxr_keyword">final</strong> InputStream is)
<a name="287" href="#287">287</a> {
<a name="288" href="#288">288</a> <strong class="jxr_keyword">if</strong> (is != <strong class="jxr_keyword">null</strong>)
<a name="289" href="#289">289</a> {
<a name="290" href="#290">290</a> <strong class="jxr_keyword">try</strong>
<a name="291" href="#291">291</a> {
<a name="292" href="#292">292</a> is.close();
<a name="293" href="#293">293</a> }
<a name="294" href="#294">294</a> <strong class="jxr_keyword">catch</strong>(IOException ioe)
<a name="295" href="#295">295</a> {
<a name="296" href="#296">296</a> <em class="jxr_comment">// Ignore</em>
<a name="297" href="#297">297</a> }
<a name="298" href="#298">298</a> }
<a name="299" href="#299">299</a> }
<a name="300" href="#300">300</a>
<a name="301" href="#301">301</a> <em class="jxr_javadoccomment">/**</em>
<a name="302" href="#302">302</a> <em class="jxr_javadoccomment"> * How to keep track of all the modified times</em>
<a name="303" href="#303">303</a> <em class="jxr_javadoccomment"> * across the paths. Note that a file might have</em>
<a name="304" href="#304">304</a> <em class="jxr_javadoccomment"> * appeared in a directory which is earlier in the</em>
<a name="305" href="#305">305</a> <em class="jxr_javadoccomment"> * path; so we should search the path and see if</em>
<a name="306" href="#306">306</a> <em class="jxr_javadoccomment"> * the file we find that way is the same as the one</em>
<a name="307" href="#307">307</a> <em class="jxr_javadoccomment"> * that we have cached.</em>
<a name="308" href="#308">308</a> <em class="jxr_javadoccomment"> * @param resource</em>
<a name="309" href="#309">309</a> <em class="jxr_javadoccomment"> * @return True if the source has been modified.</em>
<a name="310" href="#310">310</a> <em class="jxr_javadoccomment"> */</em>
<a name="311" href="#311">311</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isSourceModified(<a href="../../../../../../org/apache/velocity/runtime/resource/Resource.html">Resource</a> resource)
<a name="312" href="#312">312</a> {
<a name="313" href="#313">313</a> <em class="jxr_comment">/*</em>
<a name="314" href="#314">314</a> <em class="jxr_comment"> * we assume that the file needs to be reloaded;</em>
<a name="315" href="#315">315</a> <em class="jxr_comment"> * if we find the original file and it's unchanged,</em>
<a name="316" href="#316">316</a> <em class="jxr_comment"> * then we'll flip this.</em>
<a name="317" href="#317">317</a> <em class="jxr_comment"> */</em>
<a name="318" href="#318">318</a> <strong class="jxr_keyword">boolean</strong> modified = <strong class="jxr_keyword">true</strong>;
<a name="319" href="#319">319</a>
<a name="320" href="#320">320</a> String fileName = resource.getName();
<a name="321" href="#321">321</a> String path = (String) templatePaths.get(fileName);
<a name="322" href="#322">322</a> File currentFile = <strong class="jxr_keyword">null</strong>;
<a name="323" href="#323">323</a>
<a name="324" href="#324">324</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; currentFile == <strong class="jxr_keyword">null</strong> &amp;&amp; i &lt; paths.size(); i++)
<a name="325" href="#325">325</a> {
<a name="326" href="#326">326</a> String testPath = (String) paths.get(i);
<a name="327" href="#327">327</a> File testFile = getFile(testPath, fileName);
<a name="328" href="#328">328</a> <strong class="jxr_keyword">if</strong> (testFile.canRead())
<a name="329" href="#329">329</a> {
<a name="330" href="#330">330</a> currentFile = testFile;
<a name="331" href="#331">331</a> }
<a name="332" href="#332">332</a> }
<a name="333" href="#333">333</a> File file = getFile(path, fileName);
<a name="334" href="#334">334</a> <strong class="jxr_keyword">if</strong> (currentFile == <strong class="jxr_keyword">null</strong> || !file.exists())
<a name="335" href="#335">335</a> {
<a name="336" href="#336">336</a> <em class="jxr_comment">/*</em>
<a name="337" href="#337">337</a> <em class="jxr_comment"> * noop: if the file is missing now (either the cached</em>
<a name="338" href="#338">338</a> <em class="jxr_comment"> * file is gone, or the file can no longer be found)</em>
<a name="339" href="#339">339</a> <em class="jxr_comment"> * then we leave modified alone (it's set to true); a</em>
<a name="340" href="#340">340</a> <em class="jxr_comment"> * reload attempt will be done, which will either use</em>
<a name="341" href="#341">341</a> <em class="jxr_comment"> * a new template or fail with an appropriate message</em>
<a name="342" href="#342">342</a> <em class="jxr_comment"> * about how the file couldn't be found.</em>
<a name="343" href="#343">343</a> <em class="jxr_comment"> */</em>
<a name="344" href="#344">344</a> }
<a name="345" href="#345">345</a> <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (currentFile.equals(file) &amp;&amp; file.canRead())
<a name="346" href="#346">346</a> {
<a name="347" href="#347">347</a> <em class="jxr_comment">/*</em>
<a name="348" href="#348">348</a> <em class="jxr_comment"> * if only if currentFile is the same as file and</em>
<a name="349" href="#349">349</a> <em class="jxr_comment"> * file.lastModified() is the same as</em>
<a name="350" href="#350">350</a> <em class="jxr_comment"> * resource.getLastModified(), then we should use the</em>
<a name="351" href="#351">351</a> <em class="jxr_comment"> * cached version.</em>
<a name="352" href="#352">352</a> <em class="jxr_comment"> */</em>
<a name="353" href="#353">353</a> modified = (file.lastModified() != resource.getLastModified());
<a name="354" href="#354">354</a> }
<a name="355" href="#355">355</a>
<a name="356" href="#356">356</a> <em class="jxr_comment">/*</em>
<a name="357" href="#357">357</a> <em class="jxr_comment"> * rsvc.debug("isSourceModified for " + fileName + ": " + modified);</em>
<a name="358" href="#358">358</a> <em class="jxr_comment"> */</em>
<a name="359" href="#359">359</a> <strong class="jxr_keyword">return</strong> modified;
<a name="360" href="#360">360</a> }
<a name="361" href="#361">361</a>
<a name="362" href="#362">362</a> <em class="jxr_javadoccomment">/**</em>
<a name="363" href="#363">363</a> <em class="jxr_javadoccomment"> * @see org.apache.velocity.runtime.resource.loader.ResourceLoader#getLastModified(org.apache.velocity.runtime.resource.Resource)</em>
<a name="364" href="#364">364</a> <em class="jxr_javadoccomment"> */</em>
<a name="365" href="#365">365</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">long</strong> getLastModified(<a href="../../../../../../org/apache/velocity/runtime/resource/Resource.html">Resource</a> resource)
<a name="366" href="#366">366</a> {
<a name="367" href="#367">367</a> String path = (String) templatePaths.get(resource.getName());
<a name="368" href="#368">368</a> File file = getFile(path, resource.getName());
<a name="369" href="#369">369</a>
<a name="370" href="#370">370</a> <strong class="jxr_keyword">if</strong> (file.canRead())
<a name="371" href="#371">371</a> {
<a name="372" href="#372">372</a> <strong class="jxr_keyword">return</strong> file.lastModified();
<a name="373" href="#373">373</a> }
<a name="374" href="#374">374</a> <strong class="jxr_keyword">else</strong>
<a name="375" href="#375">375</a> {
<a name="376" href="#376">376</a> <strong class="jxr_keyword">return</strong> 0;
<a name="377" href="#377">377</a> }
<a name="378" href="#378">378</a> }
<a name="379" href="#379">379</a>
<a name="380" href="#380">380</a>
<a name="381" href="#381">381</a> <em class="jxr_javadoccomment">/**</em>
<a name="382" href="#382">382</a> <em class="jxr_javadoccomment"> * Create a File based on either a relative path if given, or absolute path otherwise</em>
<a name="383" href="#383">383</a> <em class="jxr_javadoccomment"> */</em>
<a name="384" href="#384">384</a> <strong class="jxr_keyword">private</strong> File getFile(String path, String template)
<a name="385" href="#385">385</a> {
<a name="386" href="#386">386</a>
<a name="387" href="#387">387</a> File file = <strong class="jxr_keyword">null</strong>;
<a name="388" href="#388">388</a>
<a name="389" href="#389">389</a> <strong class="jxr_keyword">if</strong>(<span class="jxr_string">""</span>.equals(path))
<a name="390" href="#390">390</a> {
<a name="391" href="#391">391</a> file = <strong class="jxr_keyword">new</strong> File( template );
<a name="392" href="#392">392</a> }
<a name="393" href="#393">393</a> <strong class="jxr_keyword">else</strong>
<a name="394" href="#394">394</a> {
<a name="395" href="#395">395</a> <em class="jxr_comment">/*</em>
<a name="396" href="#396">396</a> <em class="jxr_comment"> * if a / leads off, then just nip that :)</em>
<a name="397" href="#397">397</a> <em class="jxr_comment"> */</em>
<a name="398" href="#398">398</a> <strong class="jxr_keyword">if</strong> (template.startsWith(<span class="jxr_string">"/"</span>))
<a name="399" href="#399">399</a> {
<a name="400" href="#400">400</a> template = template.substring(1);
<a name="401" href="#401">401</a> }
<a name="402" href="#402">402</a>
<a name="403" href="#403">403</a> file = <strong class="jxr_keyword">new</strong> File ( path, template );
<a name="404" href="#404">404</a> }
<a name="405" href="#405">405</a>
<a name="406" href="#406">406</a> <strong class="jxr_keyword">return</strong> file;
<a name="407" href="#407">407</a> }
<a name="408" href="#408">408</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>