blob: 1f39253bcc515b6ede53c5632fd6b989692c87ed [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<main role="main">
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a id="line.1">/*</a>
<span class="sourceLineNo">002</span><a id="line.2"> Licensed to the Apache Software Foundation (ASF) under one</a>
<span class="sourceLineNo">003</span><a id="line.3"> or more contributor license agreements. See the NOTICE file</a>
<span class="sourceLineNo">004</span><a id="line.4"> distributed with this work for additional information</a>
<span class="sourceLineNo">005</span><a id="line.5"> regarding copyright ownership. The ASF licenses this file</a>
<span class="sourceLineNo">006</span><a id="line.6"> to you under the Apache License, Version 2.0 (the</a>
<span class="sourceLineNo">007</span><a id="line.7"> "License"); you may not use this file except in compliance</a>
<span class="sourceLineNo">008</span><a id="line.8"> with the License. You may obtain a copy of the License at</a>
<span class="sourceLineNo">009</span><a id="line.9"></a>
<span class="sourceLineNo">010</span><a id="line.10"> http://www.apache.org/licenses/LICENSE-2.0</a>
<span class="sourceLineNo">011</span><a id="line.11"></a>
<span class="sourceLineNo">012</span><a id="line.12"> Unless required by applicable law or agreed to in writing,</a>
<span class="sourceLineNo">013</span><a id="line.13"> software distributed under the License is distributed on an</a>
<span class="sourceLineNo">014</span><a id="line.14"> "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</a>
<span class="sourceLineNo">015</span><a id="line.15"> KIND, either express or implied. See the License for the</a>
<span class="sourceLineNo">016</span><a id="line.16"> specific language governing permissions and limitations</a>
<span class="sourceLineNo">017</span><a id="line.17"> under the License.</a>
<span class="sourceLineNo">018</span><a id="line.18"> */</a>
<span class="sourceLineNo">019</span><a id="line.19">package org.apache.wiki.ui;</a>
<span class="sourceLineNo">020</span><a id="line.20"></a>
<span class="sourceLineNo">021</span><a id="line.21">import org.apache.commons.lang3.StringUtils;</a>
<span class="sourceLineNo">022</span><a id="line.22">import org.apache.logging.log4j.LogManager;</a>
<span class="sourceLineNo">023</span><a id="line.23">import org.apache.logging.log4j.Logger;</a>
<span class="sourceLineNo">024</span><a id="line.24">import org.apache.logging.log4j.ThreadContext;</a>
<span class="sourceLineNo">025</span><a id="line.25">import org.apache.wiki.WatchDog;</a>
<span class="sourceLineNo">026</span><a id="line.26">import org.apache.wiki.api.core.Context;</a>
<span class="sourceLineNo">027</span><a id="line.27">import org.apache.wiki.api.core.Engine;</a>
<span class="sourceLineNo">028</span><a id="line.28">import org.apache.wiki.event.WikiEventManager;</a>
<span class="sourceLineNo">029</span><a id="line.29">import org.apache.wiki.event.WikiPageEvent;</a>
<span class="sourceLineNo">030</span><a id="line.30">import org.apache.wiki.url.URLConstructor;</a>
<span class="sourceLineNo">031</span><a id="line.31">import org.apache.wiki.util.TextUtil;</a>
<span class="sourceLineNo">032</span><a id="line.32"></a>
<span class="sourceLineNo">033</span><a id="line.33">import javax.servlet.FilterChain;</a>
<span class="sourceLineNo">034</span><a id="line.34">import javax.servlet.FilterConfig;</a>
<span class="sourceLineNo">035</span><a id="line.35">import javax.servlet.ServletException;</a>
<span class="sourceLineNo">036</span><a id="line.36">import javax.servlet.ServletOutputStream;</a>
<span class="sourceLineNo">037</span><a id="line.37">import javax.servlet.ServletRequest;</a>
<span class="sourceLineNo">038</span><a id="line.38">import javax.servlet.ServletResponse;</a>
<span class="sourceLineNo">039</span><a id="line.39">import javax.servlet.WriteListener;</a>
<span class="sourceLineNo">040</span><a id="line.40">import javax.servlet.http.HttpServletRequest;</a>
<span class="sourceLineNo">041</span><a id="line.41">import javax.servlet.http.HttpServletResponse;</a>
<span class="sourceLineNo">042</span><a id="line.42">import javax.servlet.http.HttpServletResponseWrapper;</a>
<span class="sourceLineNo">043</span><a id="line.43">import java.io.ByteArrayOutputStream;</a>
<span class="sourceLineNo">044</span><a id="line.44">import java.io.IOException;</a>
<span class="sourceLineNo">045</span><a id="line.45">import java.io.OutputStreamWriter;</a>
<span class="sourceLineNo">046</span><a id="line.46">import java.io.PrintWriter;</a>
<span class="sourceLineNo">047</span><a id="line.47">import java.io.UnsupportedEncodingException;</a>
<span class="sourceLineNo">048</span><a id="line.48"></a>
<span class="sourceLineNo">049</span><a id="line.49"></a>
<span class="sourceLineNo">050</span><a id="line.50">/**</a>
<span class="sourceLineNo">051</span><a id="line.51"> * This filter goes through the generated page response prior and places requested resources at the appropriate inclusion markers.</a>
<span class="sourceLineNo">052</span><a id="line.52"> * This is done to let dynamic content (e.g. plugins, editors) include custom resources, even after the HTML head section is</a>
<span class="sourceLineNo">053</span><a id="line.53"> * in fact built. This filter is typically the last filter to execute, and it &lt;em&gt;must&lt;/em&gt; run after servlet or JSP code that performs</a>
<span class="sourceLineNo">054</span><a id="line.54"> * redirections or sends error codes (such as access control methods).</a>
<span class="sourceLineNo">055</span><a id="line.55"> * &lt;p&gt;</a>
<span class="sourceLineNo">056</span><a id="line.56"> * Inclusion markers are placed by the IncludeResourcesTag; the default content templates (see .../templates/default/commonheader.jsp)</a>
<span class="sourceLineNo">057</span><a id="line.57"> * are configured to do this. As an example, a JavaScript resource marker is added like this:</a>
<span class="sourceLineNo">058</span><a id="line.58"> * &lt;pre&gt;</a>
<span class="sourceLineNo">059</span><a id="line.59"> * &amp;lt;wiki:IncludeResources type="script"/&amp;gt;</a>
<span class="sourceLineNo">060</span><a id="line.60"> * &lt;/pre&gt;</a>
<span class="sourceLineNo">061</span><a id="line.61"> * Any code that requires special resources must register a resource request with the TemplateManager. For example:</a>
<span class="sourceLineNo">062</span><a id="line.62"> * &lt;pre&gt;</a>
<span class="sourceLineNo">063</span><a id="line.63"> * &amp;lt;wiki:RequestResource type="script" path="scripts/custom.js" /&amp;gt;</a>
<span class="sourceLineNo">064</span><a id="line.64"> * &lt;/pre&gt;</a>
<span class="sourceLineNo">065</span><a id="line.65"> * or programmatically,</a>
<span class="sourceLineNo">066</span><a id="line.66"> * &lt;pre&gt;</a>
<span class="sourceLineNo">067</span><a id="line.67"> * TemplateManager.addResourceRequest( context, TemplateManager.RESOURCE_SCRIPT, "scripts/customresource.js" );</a>
<span class="sourceLineNo">068</span><a id="line.68"> * &lt;/pre&gt;</a>
<span class="sourceLineNo">069</span><a id="line.69"> *</a>
<span class="sourceLineNo">070</span><a id="line.70"> * @see TemplateManager</a>
<span class="sourceLineNo">071</span><a id="line.71"> * @see org.apache.wiki.tags.RequestResourceTag</a>
<span class="sourceLineNo">072</span><a id="line.72"> */</a>
<span class="sourceLineNo">073</span><a id="line.73">public class WikiJSPFilter extends WikiServletFilter {</a>
<span class="sourceLineNo">074</span><a id="line.74"></a>
<span class="sourceLineNo">075</span><a id="line.75"> private static final Logger LOG = LogManager.getLogger( WikiJSPFilter.class );</a>
<span class="sourceLineNo">076</span><a id="line.76"> private String m_wiki_encoding;</a>
<span class="sourceLineNo">077</span><a id="line.77"> private boolean useEncoding;</a>
<span class="sourceLineNo">078</span><a id="line.78"></a>
<span class="sourceLineNo">079</span><a id="line.79"> /** {@inheritDoc} */</a>
<span class="sourceLineNo">080</span><a id="line.80"> @Override</a>
<span class="sourceLineNo">081</span><a id="line.81"> public void init( final FilterConfig config ) throws ServletException {</a>
<span class="sourceLineNo">082</span><a id="line.82"> super.init( config );</a>
<span class="sourceLineNo">083</span><a id="line.83"> m_wiki_encoding = m_engine.getWikiProperties().getProperty( Engine.PROP_ENCODING );</a>
<span class="sourceLineNo">084</span><a id="line.84"></a>
<span class="sourceLineNo">085</span><a id="line.85"> useEncoding = !Boolean.parseBoolean( m_engine.getWikiProperties().getProperty( Engine.PROP_NO_FILTER_ENCODING, "false" ).trim() );</a>
<span class="sourceLineNo">086</span><a id="line.86"> }</a>
<span class="sourceLineNo">087</span><a id="line.87"></a>
<span class="sourceLineNo">088</span><a id="line.88"> @Override</a>
<span class="sourceLineNo">089</span><a id="line.89"> public void doFilter( final ServletRequest request, final ServletResponse response, final FilterChain chain ) throws ServletException, IOException {</a>
<span class="sourceLineNo">090</span><a id="line.90"> final WatchDog w = WatchDog.getCurrentWatchDog( m_engine );</a>
<span class="sourceLineNo">091</span><a id="line.91"> try {</a>
<span class="sourceLineNo">092</span><a id="line.92"> ThreadContext.push( m_engine.getApplicationName() + ":" + ( ( HttpServletRequest )request ).getRequestURI() );</a>
<span class="sourceLineNo">093</span><a id="line.93"> w.enterState("Filtering for URL "+((HttpServletRequest)request).getRequestURI(), 90 );</a>
<span class="sourceLineNo">094</span><a id="line.94"> final HttpServletResponseWrapper responseWrapper = new JSPWikiServletResponseWrapper( ( HttpServletResponse )response, m_wiki_encoding, useEncoding );</a>
<span class="sourceLineNo">095</span><a id="line.95"> request.setCharacterEncoding( m_engine.getContentEncoding().displayName() );</a>
<span class="sourceLineNo">096</span><a id="line.96"></a>
<span class="sourceLineNo">097</span><a id="line.97"> // fire PAGE_REQUESTED event</a>
<span class="sourceLineNo">098</span><a id="line.98"> final String pagename = URLConstructor.parsePageFromURL( ( HttpServletRequest )request, m_engine.getContentEncoding() );</a>
<span class="sourceLineNo">099</span><a id="line.99"> fireEvent( WikiPageEvent.PAGE_REQUESTED, pagename != null ? pagename : m_engine.getFrontPage() );</a>
<span class="sourceLineNo">100</span><a id="line.100"> super.doFilter( request, responseWrapper, chain );</a>
<span class="sourceLineNo">101</span><a id="line.101"></a>
<span class="sourceLineNo">102</span><a id="line.102"> // The response is now complete. Let's replace the markers now.</a>
<span class="sourceLineNo">103</span><a id="line.103"></a>
<span class="sourceLineNo">104</span><a id="line.104"> // WikiContext is only available after doFilter! (That is after interpreting the jsp)</a>
<span class="sourceLineNo">105</span><a id="line.105"></a>
<span class="sourceLineNo">106</span><a id="line.106"> try {</a>
<span class="sourceLineNo">107</span><a id="line.107"> w.enterState( "Delivering response", 30 );</a>
<span class="sourceLineNo">108</span><a id="line.108"> final Context wikiContext = getWikiContext( request );</a>
<span class="sourceLineNo">109</span><a id="line.109"> final String r = filter( wikiContext, responseWrapper );</a>
<span class="sourceLineNo">110</span><a id="line.110"></a>
<span class="sourceLineNo">111</span><a id="line.111"> if( useEncoding ) {</a>
<span class="sourceLineNo">112</span><a id="line.112"> final OutputStreamWriter out = new OutputStreamWriter( response.getOutputStream(), response.getCharacterEncoding() );</a>
<span class="sourceLineNo">113</span><a id="line.113"> out.write( r );</a>
<span class="sourceLineNo">114</span><a id="line.114"> out.flush();</a>
<span class="sourceLineNo">115</span><a id="line.115"> out.close();</a>
<span class="sourceLineNo">116</span><a id="line.116"> } else {</a>
<span class="sourceLineNo">117</span><a id="line.117"> response.getWriter().write(r);</a>
<span class="sourceLineNo">118</span><a id="line.118"> }</a>
<span class="sourceLineNo">119</span><a id="line.119"></a>
<span class="sourceLineNo">120</span><a id="line.120"> // Clean up the UI messages and loggers</a>
<span class="sourceLineNo">121</span><a id="line.121"> if( wikiContext != null ) {</a>
<span class="sourceLineNo">122</span><a id="line.122"> wikiContext.getWikiSession().clearMessages();</a>
<span class="sourceLineNo">123</span><a id="line.123"> }</a>
<span class="sourceLineNo">124</span><a id="line.124"></a>
<span class="sourceLineNo">125</span><a id="line.125"> // fire PAGE_DELIVERED event</a>
<span class="sourceLineNo">126</span><a id="line.126"> fireEvent( WikiPageEvent.PAGE_DELIVERED, pagename );</a>
<span class="sourceLineNo">127</span><a id="line.127"></a>
<span class="sourceLineNo">128</span><a id="line.128"> } finally {</a>
<span class="sourceLineNo">129</span><a id="line.129"> w.exitState();</a>
<span class="sourceLineNo">130</span><a id="line.130"> }</a>
<span class="sourceLineNo">131</span><a id="line.131"> } finally {</a>
<span class="sourceLineNo">132</span><a id="line.132"> w.exitState();</a>
<span class="sourceLineNo">133</span><a id="line.133"> ThreadContext.pop();</a>
<span class="sourceLineNo">134</span><a id="line.134"> ThreadContext.remove( m_engine.getApplicationName() + ":" + ( ( HttpServletRequest )request ).getRequestURI() );</a>
<span class="sourceLineNo">135</span><a id="line.135"> }</a>
<span class="sourceLineNo">136</span><a id="line.136"> }</a>
<span class="sourceLineNo">137</span><a id="line.137"></a>
<span class="sourceLineNo">138</span><a id="line.138"> /**</a>
<span class="sourceLineNo">139</span><a id="line.139"> * Goes through all types and writes the appropriate response.</a>
<span class="sourceLineNo">140</span><a id="line.140"> *</a>
<span class="sourceLineNo">141</span><a id="line.141"> * @param wikiContext The usual processing context</a>
<span class="sourceLineNo">142</span><a id="line.142"> * @param response The source string</a>
<span class="sourceLineNo">143</span><a id="line.143"> * @return The modified string with all the insertions in place.</a>
<span class="sourceLineNo">144</span><a id="line.144"> */</a>
<span class="sourceLineNo">145</span><a id="line.145"> private String filter( final Context wikiContext, final HttpServletResponse response ) {</a>
<span class="sourceLineNo">146</span><a id="line.146"> String string = response.toString();</a>
<span class="sourceLineNo">147</span><a id="line.147"></a>
<span class="sourceLineNo">148</span><a id="line.148"> if( wikiContext != null ) {</a>
<span class="sourceLineNo">149</span><a id="line.149"> final String[] resourceTypes = TemplateManager.getResourceTypes( wikiContext );</a>
<span class="sourceLineNo">150</span><a id="line.150"> for( final String resourceType : resourceTypes ) {</a>
<span class="sourceLineNo">151</span><a id="line.151"> string = insertResources( wikiContext, string, resourceType );</a>
<span class="sourceLineNo">152</span><a id="line.152"> }</a>
<span class="sourceLineNo">153</span><a id="line.153"></a>
<span class="sourceLineNo">154</span><a id="line.154"> // Add HTTP header Resource Requests</a>
<span class="sourceLineNo">155</span><a id="line.155"> final String[] headers = TemplateManager.getResourceRequests( wikiContext, TemplateManager.RESOURCE_HTTPHEADER );</a>
<span class="sourceLineNo">156</span><a id="line.156"></a>
<span class="sourceLineNo">157</span><a id="line.157"> for( final String header : headers ) {</a>
<span class="sourceLineNo">158</span><a id="line.158"> String key = header;</a>
<span class="sourceLineNo">159</span><a id="line.159"> String value = "";</a>
<span class="sourceLineNo">160</span><a id="line.160"> final int split = header.indexOf( ':' );</a>
<span class="sourceLineNo">161</span><a id="line.161"> if( split &gt; 0 &amp;&amp; split &lt; header.length() - 1 ) {</a>
<span class="sourceLineNo">162</span><a id="line.162"> key = header.substring( 0, split );</a>
<span class="sourceLineNo">163</span><a id="line.163"> value = header.substring( split + 1 );</a>
<span class="sourceLineNo">164</span><a id="line.164"> }</a>
<span class="sourceLineNo">165</span><a id="line.165"></a>
<span class="sourceLineNo">166</span><a id="line.166"> response.addHeader( key.trim(), value.trim() );</a>
<span class="sourceLineNo">167</span><a id="line.167"> }</a>
<span class="sourceLineNo">168</span><a id="line.168"> }</a>
<span class="sourceLineNo">169</span><a id="line.169"></a>
<span class="sourceLineNo">170</span><a id="line.170"> return string;</a>
<span class="sourceLineNo">171</span><a id="line.171"> }</a>
<span class="sourceLineNo">172</span><a id="line.172"></a>
<span class="sourceLineNo">173</span><a id="line.173"> /**</a>
<span class="sourceLineNo">174</span><a id="line.174"> * Inserts whatever resources were requested by any plugins or other components for this particular type.</a>
<span class="sourceLineNo">175</span><a id="line.175"> *</a>
<span class="sourceLineNo">176</span><a id="line.176"> * @param wikiContext The usual processing context</a>
<span class="sourceLineNo">177</span><a id="line.177"> * @param string The source string</a>
<span class="sourceLineNo">178</span><a id="line.178"> * @param type Type identifier for insertion</a>
<span class="sourceLineNo">179</span><a id="line.179"> * @return The filtered string.</a>
<span class="sourceLineNo">180</span><a id="line.180"> */</a>
<span class="sourceLineNo">181</span><a id="line.181"> private String insertResources( final Context wikiContext, final String string, final String type ) {</a>
<span class="sourceLineNo">182</span><a id="line.182"> if( wikiContext == null ) {</a>
<span class="sourceLineNo">183</span><a id="line.183"> return string;</a>
<span class="sourceLineNo">184</span><a id="line.184"> }</a>
<span class="sourceLineNo">185</span><a id="line.185"></a>
<span class="sourceLineNo">186</span><a id="line.186"> final String marker = TemplateManager.getMarker( wikiContext, type );</a>
<span class="sourceLineNo">187</span><a id="line.187"> final int idx = string.indexOf( marker );</a>
<span class="sourceLineNo">188</span><a id="line.188"> if( idx == -1 ) {</a>
<span class="sourceLineNo">189</span><a id="line.189"> return string;</a>
<span class="sourceLineNo">190</span><a id="line.190"> }</a>
<span class="sourceLineNo">191</span><a id="line.191"></a>
<span class="sourceLineNo">192</span><a id="line.192"> LOG.debug("...Inserting...");</a>
<span class="sourceLineNo">193</span><a id="line.193"></a>
<span class="sourceLineNo">194</span><a id="line.194"> final String[] resources = TemplateManager.getResourceRequests( wikiContext, type );</a>
<span class="sourceLineNo">195</span><a id="line.195"> final StringBuilder concat = new StringBuilder( resources.length * 40 );</a>
<span class="sourceLineNo">196</span><a id="line.196"></a>
<span class="sourceLineNo">197</span><a id="line.197"> for( final String resource : resources ) {</a>
<span class="sourceLineNo">198</span><a id="line.198"> LOG.debug( "...:::" + resource );</a>
<span class="sourceLineNo">199</span><a id="line.199"> concat.append( resource );</a>
<span class="sourceLineNo">200</span><a id="line.200"> }</a>
<span class="sourceLineNo">201</span><a id="line.201"></a>
<span class="sourceLineNo">202</span><a id="line.202"> return TextUtil.replaceString( string, idx, idx + marker.length(), concat.toString() );</a>
<span class="sourceLineNo">203</span><a id="line.203"> }</a>
<span class="sourceLineNo">204</span><a id="line.204"></a>
<span class="sourceLineNo">205</span><a id="line.205"> /**</a>
<span class="sourceLineNo">206</span><a id="line.206"> * Simple response wrapper that just allows us to gobble through the entire</a>
<span class="sourceLineNo">207</span><a id="line.207"> * response before it's output.</a>
<span class="sourceLineNo">208</span><a id="line.208"> */</a>
<span class="sourceLineNo">209</span><a id="line.209"> private static class JSPWikiServletResponseWrapper extends HttpServletResponseWrapper {</a>
<span class="sourceLineNo">210</span><a id="line.210"></a>
<span class="sourceLineNo">211</span><a id="line.211"> final ByteArrayOutputStream m_output;</a>
<span class="sourceLineNo">212</span><a id="line.212"> private final ByteArrayServletOutputStream m_servletOut;</a>
<span class="sourceLineNo">213</span><a id="line.213"> private final PrintWriter m_writer;</a>
<span class="sourceLineNo">214</span><a id="line.214"> private final HttpServletResponse m_response;</a>
<span class="sourceLineNo">215</span><a id="line.215"> private final boolean useEncoding;</a>
<span class="sourceLineNo">216</span><a id="line.216"></a>
<span class="sourceLineNo">217</span><a id="line.217"> /** How large the initial buffer should be. This should be tuned to achieve a balance in speed and memory consumption. */</a>
<span class="sourceLineNo">218</span><a id="line.218"> private static final int INIT_BUFFER_SIZE = 0x8000;</a>
<span class="sourceLineNo">219</span><a id="line.219"></a>
<span class="sourceLineNo">220</span><a id="line.220"> public JSPWikiServletResponseWrapper( final HttpServletResponse r, final String wikiEncoding, final boolean useEncoding ) throws UnsupportedEncodingException {</a>
<span class="sourceLineNo">221</span><a id="line.221"> super( r );</a>
<span class="sourceLineNo">222</span><a id="line.222"> m_output = new ByteArrayOutputStream( INIT_BUFFER_SIZE );</a>
<span class="sourceLineNo">223</span><a id="line.223"> m_servletOut = new ByteArrayServletOutputStream( m_output );</a>
<span class="sourceLineNo">224</span><a id="line.224"> m_writer = new PrintWriter( new OutputStreamWriter( m_servletOut, wikiEncoding ), true );</a>
<span class="sourceLineNo">225</span><a id="line.225"> this.useEncoding = useEncoding;</a>
<span class="sourceLineNo">226</span><a id="line.226"></a>
<span class="sourceLineNo">227</span><a id="line.227"> m_response = r;</a>
<span class="sourceLineNo">228</span><a id="line.228"> }</a>
<span class="sourceLineNo">229</span><a id="line.229"></a>
<span class="sourceLineNo">230</span><a id="line.230"> /** Returns a writer for output; this wraps the internal buffer into a PrintWriter. */</a>
<span class="sourceLineNo">231</span><a id="line.231"> @Override</a>
<span class="sourceLineNo">232</span><a id="line.232"> public PrintWriter getWriter() {</a>
<span class="sourceLineNo">233</span><a id="line.233"> return m_writer;</a>
<span class="sourceLineNo">234</span><a id="line.234"> }</a>
<span class="sourceLineNo">235</span><a id="line.235"></a>
<span class="sourceLineNo">236</span><a id="line.236"> @Override</a>
<span class="sourceLineNo">237</span><a id="line.237"> public ServletOutputStream getOutputStream() {</a>
<span class="sourceLineNo">238</span><a id="line.238"> return m_servletOut;</a>
<span class="sourceLineNo">239</span><a id="line.239"> }</a>
<span class="sourceLineNo">240</span><a id="line.240"></a>
<span class="sourceLineNo">241</span><a id="line.241"> @Override</a>
<span class="sourceLineNo">242</span><a id="line.242"> public void flushBuffer() throws IOException {</a>
<span class="sourceLineNo">243</span><a id="line.243"> m_writer.flush();</a>
<span class="sourceLineNo">244</span><a id="line.244"> super.flushBuffer();</a>
<span class="sourceLineNo">245</span><a id="line.245"> }</a>
<span class="sourceLineNo">246</span><a id="line.246"></a>
<span class="sourceLineNo">247</span><a id="line.247"> class ByteArrayServletOutputStream extends ServletOutputStream {</a>
<span class="sourceLineNo">248</span><a id="line.248"></a>
<span class="sourceLineNo">249</span><a id="line.249"> final ByteArrayOutputStream m_buffer;</a>
<span class="sourceLineNo">250</span><a id="line.250"></a>
<span class="sourceLineNo">251</span><a id="line.251"> public ByteArrayServletOutputStream( final ByteArrayOutputStream byteArrayOutputStream ) {</a>
<span class="sourceLineNo">252</span><a id="line.252"> super();</a>
<span class="sourceLineNo">253</span><a id="line.253"> m_buffer = byteArrayOutputStream;</a>
<span class="sourceLineNo">254</span><a id="line.254"> }</a>
<span class="sourceLineNo">255</span><a id="line.255"></a>
<span class="sourceLineNo">256</span><a id="line.256"> //</a>
<span class="sourceLineNo">257</span><a id="line.257"> /**{@inheritDoc} */</a>
<span class="sourceLineNo">258</span><a id="line.258"> @Override</a>
<span class="sourceLineNo">259</span><a id="line.259"> public void write( final int aInt ) {</a>
<span class="sourceLineNo">260</span><a id="line.260"> m_buffer.write( aInt );</a>
<span class="sourceLineNo">261</span><a id="line.261"> }</a>
<span class="sourceLineNo">262</span><a id="line.262"></a>
<span class="sourceLineNo">263</span><a id="line.263"> /**{@inheritDoc} */</a>
<span class="sourceLineNo">264</span><a id="line.264"> @Override</a>
<span class="sourceLineNo">265</span><a id="line.265"> public boolean isReady() {</a>
<span class="sourceLineNo">266</span><a id="line.266"> return false;</a>
<span class="sourceLineNo">267</span><a id="line.267"> }</a>
<span class="sourceLineNo">268</span><a id="line.268"></a>
<span class="sourceLineNo">269</span><a id="line.269"> /**{@inheritDoc} */</a>
<span class="sourceLineNo">270</span><a id="line.270"> @Override</a>
<span class="sourceLineNo">271</span><a id="line.271"> public void setWriteListener( final WriteListener writeListener ) {</a>
<span class="sourceLineNo">272</span><a id="line.272"> }</a>
<span class="sourceLineNo">273</span><a id="line.273"> </a>
<span class="sourceLineNo">274</span><a id="line.274"> }</a>
<span class="sourceLineNo">275</span><a id="line.275"></a>
<span class="sourceLineNo">276</span><a id="line.276"> /** Returns whatever was written so far into the Writer. */</a>
<span class="sourceLineNo">277</span><a id="line.277"> @Override</a>
<span class="sourceLineNo">278</span><a id="line.278"> public String toString() {</a>
<span class="sourceLineNo">279</span><a id="line.279"> try {</a>
<span class="sourceLineNo">280</span><a id="line.280"> flushBuffer();</a>
<span class="sourceLineNo">281</span><a id="line.281"> } catch( final IOException e ) {</a>
<span class="sourceLineNo">282</span><a id="line.282"> LOG.error( e );</a>
<span class="sourceLineNo">283</span><a id="line.283"> return StringUtils.EMPTY;</a>
<span class="sourceLineNo">284</span><a id="line.284"> }</a>
<span class="sourceLineNo">285</span><a id="line.285"></a>
<span class="sourceLineNo">286</span><a id="line.286"> try {</a>
<span class="sourceLineNo">287</span><a id="line.287"> if( useEncoding ) {</a>
<span class="sourceLineNo">288</span><a id="line.288"> return m_output.toString( m_response.getCharacterEncoding() );</a>
<span class="sourceLineNo">289</span><a id="line.289"> }</a>
<span class="sourceLineNo">290</span><a id="line.290"></a>
<span class="sourceLineNo">291</span><a id="line.291"> return m_output.toString();</a>
<span class="sourceLineNo">292</span><a id="line.292"> } catch( final UnsupportedEncodingException e ) {</a>
<span class="sourceLineNo">293</span><a id="line.293"> LOG.error( e );</a>
<span class="sourceLineNo">294</span><a id="line.294"> return StringUtils.EMPTY;</a>
<span class="sourceLineNo">295</span><a id="line.295"> }</a>
<span class="sourceLineNo">296</span><a id="line.296"> }</a>
<span class="sourceLineNo">297</span><a id="line.297"></a>
<span class="sourceLineNo">298</span><a id="line.298"> }</a>
<span class="sourceLineNo">299</span><a id="line.299"></a>
<span class="sourceLineNo">300</span><a id="line.300"> // events processing .......................................................</a>
<span class="sourceLineNo">301</span><a id="line.301"></a>
<span class="sourceLineNo">302</span><a id="line.302"> /**</a>
<span class="sourceLineNo">303</span><a id="line.303"> * Fires a WikiPageEvent of the provided type and page name</a>
<span class="sourceLineNo">304</span><a id="line.304"> * to all registered listeners of the current Engine.</a>
<span class="sourceLineNo">305</span><a id="line.305"> *</a>
<span class="sourceLineNo">306</span><a id="line.306"> * @see org.apache.wiki.event.WikiPageEvent</a>
<span class="sourceLineNo">307</span><a id="line.307"> * @param type the event type to be fired</a>
<span class="sourceLineNo">308</span><a id="line.308"> * @param pagename the wiki page name as a String</a>
<span class="sourceLineNo">309</span><a id="line.309"> */</a>
<span class="sourceLineNo">310</span><a id="line.310"> protected final void fireEvent( final int type, final String pagename ) {</a>
<span class="sourceLineNo">311</span><a id="line.311"> if( WikiEventManager.isListening( m_engine ) ) {</a>
<span class="sourceLineNo">312</span><a id="line.312"> WikiEventManager.fireEvent( m_engine, new WikiPageEvent( m_engine, type, pagename ) );</a>
<span class="sourceLineNo">313</span><a id="line.313"> }</a>
<span class="sourceLineNo">314</span><a id="line.314"> }</a>
<span class="sourceLineNo">315</span><a id="line.315"></a>
<span class="sourceLineNo">316</span><a id="line.316">}</a>
</pre>
</div>
</main>
</body>
</html>