blob: 9638bf8c8db1441e531ab961f88898d726547774 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
<span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
<span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a>
<span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a>
<span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a>
<span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a>
<span class="sourceLineNo">009</span> * <a name="line.9"></a>
<span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<span class="sourceLineNo">011</span> * <a name="line.11"></a>
<span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing,<a name="line.12"></a>
<span class="sourceLineNo">013</span> * software distributed under the License is distributed on an<a name="line.13"></a>
<span class="sourceLineNo">014</span> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a>
<span class="sourceLineNo">015</span> * KIND, either express or implied. See the License for the<a name="line.15"></a>
<span class="sourceLineNo">016</span> * specific language governing permissions and limitations<a name="line.16"></a>
<span class="sourceLineNo">017</span> * under the License. <a name="line.17"></a>
<span class="sourceLineNo">018</span> * <a name="line.18"></a>
<span class="sourceLineNo">019</span> */<a name="line.19"></a>
<span class="sourceLineNo">020</span>package org.apache.mina.http;<a name="line.20"></a>
<span class="sourceLineNo">021</span><a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.nio.ByteBuffer;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.util.HashMap;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.util.Map;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.util.regex.Pattern;<a name="line.25"></a>
<span class="sourceLineNo">026</span><a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.mina.core.buffer.IoBuffer;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.mina.core.session.IoSession;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.mina.filter.codec.ProtocolDecoder;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.mina.filter.codec.ProtocolDecoderOutput;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.mina.http.api.HttpEndOfContent;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.mina.http.api.HttpMethod;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.mina.http.api.HttpStatus;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.apache.mina.http.api.HttpVersion;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import org.slf4j.Logger;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import org.slf4j.LoggerFactory;<a name="line.36"></a>
<span class="sourceLineNo">037</span><a name="line.37"></a>
<span class="sourceLineNo">038</span>public class HttpServerDecoder implements ProtocolDecoder {<a name="line.38"></a>
<span class="sourceLineNo">039</span> private static final Logger LOG = LoggerFactory.getLogger(HttpServerCodec.class);<a name="line.39"></a>
<span class="sourceLineNo">040</span><a name="line.40"></a>
<span class="sourceLineNo">041</span> /** Key for decoder current state */<a name="line.41"></a>
<span class="sourceLineNo">042</span> private static final String DECODER_STATE_ATT = "http.ds";<a name="line.42"></a>
<span class="sourceLineNo">043</span><a name="line.43"></a>
<span class="sourceLineNo">044</span> /** Key for the partial HTTP requests head */<a name="line.44"></a>
<span class="sourceLineNo">045</span> private static final String PARTIAL_HEAD_ATT = "http.ph";<a name="line.45"></a>
<span class="sourceLineNo">046</span><a name="line.46"></a>
<span class="sourceLineNo">047</span> /** Key for the number of bytes remaining to read for completing the body */<a name="line.47"></a>
<span class="sourceLineNo">048</span> private static final String BODY_REMAINING_BYTES = "http.brb";<a name="line.48"></a>
<span class="sourceLineNo">049</span><a name="line.49"></a>
<span class="sourceLineNo">050</span> /** Regex to parse HttpRequest Request Line */<a name="line.50"></a>
<span class="sourceLineNo">051</span> public static final Pattern REQUEST_LINE_PATTERN = Pattern.compile(" ");<a name="line.51"></a>
<span class="sourceLineNo">052</span><a name="line.52"></a>
<span class="sourceLineNo">053</span> /** Regex to parse out QueryString from HttpRequest */<a name="line.53"></a>
<span class="sourceLineNo">054</span> public static final Pattern QUERY_STRING_PATTERN = Pattern.compile("\\?");<a name="line.54"></a>
<span class="sourceLineNo">055</span><a name="line.55"></a>
<span class="sourceLineNo">056</span> /** Regex to parse out parameters from query string */<a name="line.56"></a>
<span class="sourceLineNo">057</span> public static final Pattern PARAM_STRING_PATTERN = Pattern.compile("\\&amp;|;");<a name="line.57"></a>
<span class="sourceLineNo">058</span><a name="line.58"></a>
<span class="sourceLineNo">059</span> /** Regex to parse out key/value pairs */<a name="line.59"></a>
<span class="sourceLineNo">060</span> public static final Pattern KEY_VALUE_PATTERN = Pattern.compile("=");<a name="line.60"></a>
<span class="sourceLineNo">061</span><a name="line.61"></a>
<span class="sourceLineNo">062</span> /** Regex to parse raw headers and body */<a name="line.62"></a>
<span class="sourceLineNo">063</span> public static final Pattern RAW_VALUE_PATTERN = Pattern.compile("\\r\\n\\r\\n");<a name="line.63"></a>
<span class="sourceLineNo">064</span><a name="line.64"></a>
<span class="sourceLineNo">065</span> /** Regex to parse raw headers from body */<a name="line.65"></a>
<span class="sourceLineNo">066</span> public static final Pattern HEADERS_BODY_PATTERN = Pattern.compile("\\r\\n");<a name="line.66"></a>
<span class="sourceLineNo">067</span><a name="line.67"></a>
<span class="sourceLineNo">068</span> /** Regex to parse header name and value */<a name="line.68"></a>
<span class="sourceLineNo">069</span> public static final Pattern HEADER_VALUE_PATTERN = Pattern.compile(":");<a name="line.69"></a>
<span class="sourceLineNo">070</span><a name="line.70"></a>
<span class="sourceLineNo">071</span> /** Regex to split cookie header following RFC6265 Section 5.4 */<a name="line.71"></a>
<span class="sourceLineNo">072</span> public static final Pattern COOKIE_SEPARATOR_PATTERN = Pattern.compile(";");<a name="line.72"></a>
<span class="sourceLineNo">073</span><a name="line.73"></a>
<span class="sourceLineNo">074</span> public void decode(IoSession session, IoBuffer msg, ProtocolDecoderOutput out) {<a name="line.74"></a>
<span class="sourceLineNo">075</span> DecoderState state = (DecoderState) session.getAttribute(DECODER_STATE_ATT);<a name="line.75"></a>
<span class="sourceLineNo">076</span> if (null == state) {<a name="line.76"></a>
<span class="sourceLineNo">077</span> session.setAttribute(DECODER_STATE_ATT, DecoderState.NEW);<a name="line.77"></a>
<span class="sourceLineNo">078</span> state = (DecoderState) session.getAttribute(DECODER_STATE_ATT);<a name="line.78"></a>
<span class="sourceLineNo">079</span> }<a name="line.79"></a>
<span class="sourceLineNo">080</span> switch (state) {<a name="line.80"></a>
<span class="sourceLineNo">081</span> case HEAD:<a name="line.81"></a>
<span class="sourceLineNo">082</span> LOG.debug("decoding HEAD");<a name="line.82"></a>
<span class="sourceLineNo">083</span> // grab the stored a partial HEAD request<a name="line.83"></a>
<span class="sourceLineNo">084</span> final ByteBuffer oldBuffer = (ByteBuffer) session.getAttribute(PARTIAL_HEAD_ATT);<a name="line.84"></a>
<span class="sourceLineNo">085</span> // concat the old buffer and the new incoming one<a name="line.85"></a>
<span class="sourceLineNo">086</span> // now let's decode like it was a new message<a name="line.86"></a>
<span class="sourceLineNo">087</span> msg = IoBuffer.allocate(oldBuffer.remaining() + msg.remaining()).put(oldBuffer).put(msg).flip();<a name="line.87"></a>
<span class="sourceLineNo">088</span> case NEW:<a name="line.88"></a>
<span class="sourceLineNo">089</span> LOG.debug("decoding NEW");<a name="line.89"></a>
<span class="sourceLineNo">090</span> HttpRequestImpl rq = parseHttpRequestHead(msg.buf());<a name="line.90"></a>
<span class="sourceLineNo">091</span><a name="line.91"></a>
<span class="sourceLineNo">092</span> if (rq == null) {<a name="line.92"></a>
<span class="sourceLineNo">093</span> // we copy the incoming BB because it's going to be recycled by the inner IoProcessor for next reads<a name="line.93"></a>
<span class="sourceLineNo">094</span> ByteBuffer partial = ByteBuffer.allocate(msg.remaining());<a name="line.94"></a>
<span class="sourceLineNo">095</span> partial.put(msg.buf());<a name="line.95"></a>
<span class="sourceLineNo">096</span> partial.flip();<a name="line.96"></a>
<span class="sourceLineNo">097</span> // no request decoded, we accumulate<a name="line.97"></a>
<span class="sourceLineNo">098</span> session.setAttribute(PARTIAL_HEAD_ATT, partial);<a name="line.98"></a>
<span class="sourceLineNo">099</span> session.setAttribute(DECODER_STATE_ATT, DecoderState.HEAD);<a name="line.99"></a>
<span class="sourceLineNo">100</span> break;<a name="line.100"></a>
<span class="sourceLineNo">101</span> } else {<a name="line.101"></a>
<span class="sourceLineNo">102</span> out.write(rq);<a name="line.102"></a>
<span class="sourceLineNo">103</span> // is it a request with some body content ?<a name="line.103"></a>
<span class="sourceLineNo">104</span> String contentLen = rq.getHeader("content-length");<a name="line.104"></a>
<span class="sourceLineNo">105</span><a name="line.105"></a>
<span class="sourceLineNo">106</span> if (contentLen != null) {<a name="line.106"></a>
<span class="sourceLineNo">107</span> LOG.debug("found content len : {}", contentLen);<a name="line.107"></a>
<span class="sourceLineNo">108</span> session.setAttribute(BODY_REMAINING_BYTES, Integer.valueOf(contentLen));<a name="line.108"></a>
<span class="sourceLineNo">109</span> session.setAttribute(DECODER_STATE_ATT, DecoderState.BODY);<a name="line.109"></a>
<span class="sourceLineNo">110</span> // fallthrough, process body immediately<a name="line.110"></a>
<span class="sourceLineNo">111</span> } else {<a name="line.111"></a>
<span class="sourceLineNo">112</span> LOG.debug("request without content");<a name="line.112"></a>
<span class="sourceLineNo">113</span> session.setAttribute(DECODER_STATE_ATT, DecoderState.NEW);<a name="line.113"></a>
<span class="sourceLineNo">114</span> out.write(new HttpEndOfContent());<a name="line.114"></a>
<span class="sourceLineNo">115</span> break;<a name="line.115"></a>
<span class="sourceLineNo">116</span> }<a name="line.116"></a>
<span class="sourceLineNo">117</span> }<a name="line.117"></a>
<span class="sourceLineNo">118</span><a name="line.118"></a>
<span class="sourceLineNo">119</span> case BODY:<a name="line.119"></a>
<span class="sourceLineNo">120</span> LOG.debug("decoding BODY: {} bytes", msg.remaining());<a name="line.120"></a>
<span class="sourceLineNo">121</span> final int chunkSize = msg.remaining();<a name="line.121"></a>
<span class="sourceLineNo">122</span> // send the chunk of body<a name="line.122"></a>
<span class="sourceLineNo">123</span> if (chunkSize != 0) {<a name="line.123"></a>
<span class="sourceLineNo">124</span> final IoBuffer wb = IoBuffer.allocate(msg.remaining());<a name="line.124"></a>
<span class="sourceLineNo">125</span> wb.put(msg);<a name="line.125"></a>
<span class="sourceLineNo">126</span> wb.flip();<a name="line.126"></a>
<span class="sourceLineNo">127</span> out.write(wb);<a name="line.127"></a>
<span class="sourceLineNo">128</span> }<a name="line.128"></a>
<span class="sourceLineNo">129</span> msg.position(msg.limit());<a name="line.129"></a>
<span class="sourceLineNo">130</span> // do we have reach end of body ?<a name="line.130"></a>
<span class="sourceLineNo">131</span> int remaining = (Integer) session.getAttribute(BODY_REMAINING_BYTES);<a name="line.131"></a>
<span class="sourceLineNo">132</span> remaining -= chunkSize;<a name="line.132"></a>
<span class="sourceLineNo">133</span><a name="line.133"></a>
<span class="sourceLineNo">134</span> if (remaining &lt;= 0) {<a name="line.134"></a>
<span class="sourceLineNo">135</span> LOG.debug("end of HTTP body");<a name="line.135"></a>
<span class="sourceLineNo">136</span> session.setAttribute(DECODER_STATE_ATT, DecoderState.NEW);<a name="line.136"></a>
<span class="sourceLineNo">137</span> session.removeAttribute(BODY_REMAINING_BYTES);<a name="line.137"></a>
<span class="sourceLineNo">138</span> out.write(new HttpEndOfContent());<a name="line.138"></a>
<span class="sourceLineNo">139</span> } else {<a name="line.139"></a>
<span class="sourceLineNo">140</span> session.setAttribute(BODY_REMAINING_BYTES, Integer.valueOf(remaining));<a name="line.140"></a>
<span class="sourceLineNo">141</span> }<a name="line.141"></a>
<span class="sourceLineNo">142</span><a name="line.142"></a>
<span class="sourceLineNo">143</span> break;<a name="line.143"></a>
<span class="sourceLineNo">144</span><a name="line.144"></a>
<span class="sourceLineNo">145</span> default:<a name="line.145"></a>
<span class="sourceLineNo">146</span> throw new HttpException(HttpStatus.CLIENT_ERROR_BAD_REQUEST, "Unknonwn decoder state : " + state);<a name="line.146"></a>
<span class="sourceLineNo">147</span> }<a name="line.147"></a>
<span class="sourceLineNo">148</span> }<a name="line.148"></a>
<span class="sourceLineNo">149</span><a name="line.149"></a>
<span class="sourceLineNo">150</span> public void finishDecode(final IoSession session, final ProtocolDecoderOutput out) throws Exception {<a name="line.150"></a>
<span class="sourceLineNo">151</span> }<a name="line.151"></a>
<span class="sourceLineNo">152</span><a name="line.152"></a>
<span class="sourceLineNo">153</span> public void dispose(final IoSession session) throws Exception {<a name="line.153"></a>
<span class="sourceLineNo">154</span> }<a name="line.154"></a>
<span class="sourceLineNo">155</span><a name="line.155"></a>
<span class="sourceLineNo">156</span> private HttpRequestImpl parseHttpRequestHead(final ByteBuffer buffer) {<a name="line.156"></a>
<span class="sourceLineNo">157</span> // Java 6 &gt;&gt; String raw = new String(buffer.array(), 0, buffer.limit(), Charset.forName("UTF-8"));<a name="line.157"></a>
<span class="sourceLineNo">158</span> final String raw = new String(buffer.array(), 0, buffer.limit());<a name="line.158"></a>
<span class="sourceLineNo">159</span> final String[] headersAndBody = RAW_VALUE_PATTERN.split(raw, -1);<a name="line.159"></a>
<span class="sourceLineNo">160</span><a name="line.160"></a>
<span class="sourceLineNo">161</span> if (headersAndBody.length &lt;= 1) {<a name="line.161"></a>
<span class="sourceLineNo">162</span> // we didn't receive the full HTTP head<a name="line.162"></a>
<span class="sourceLineNo">163</span> return null;<a name="line.163"></a>
<span class="sourceLineNo">164</span> }<a name="line.164"></a>
<span class="sourceLineNo">165</span><a name="line.165"></a>
<span class="sourceLineNo">166</span> String[] headerFields = HEADERS_BODY_PATTERN.split(headersAndBody[0]);<a name="line.166"></a>
<span class="sourceLineNo">167</span> headerFields = ArrayUtil.dropFromEndWhile(headerFields, "");<a name="line.167"></a>
<span class="sourceLineNo">168</span><a name="line.168"></a>
<span class="sourceLineNo">169</span> final String requestLine = headerFields[0];<a name="line.169"></a>
<span class="sourceLineNo">170</span> final Map&lt;String, String&gt; generalHeaders = new HashMap&lt;String, String&gt;();<a name="line.170"></a>
<span class="sourceLineNo">171</span><a name="line.171"></a>
<span class="sourceLineNo">172</span> for (int i = 1; i &lt; headerFields.length; i++) {<a name="line.172"></a>
<span class="sourceLineNo">173</span> final String[] header = HEADER_VALUE_PATTERN.split(headerFields[i]);<a name="line.173"></a>
<span class="sourceLineNo">174</span> generalHeaders.put(header[0].toLowerCase(), header[1].trim());<a name="line.174"></a>
<span class="sourceLineNo">175</span> }<a name="line.175"></a>
<span class="sourceLineNo">176</span><a name="line.176"></a>
<span class="sourceLineNo">177</span> final String[] elements = REQUEST_LINE_PATTERN.split(requestLine);<a name="line.177"></a>
<span class="sourceLineNo">178</span> final HttpMethod method = HttpMethod.valueOf(elements[0]);<a name="line.178"></a>
<span class="sourceLineNo">179</span> final HttpVersion version = HttpVersion.fromString(elements[2]);<a name="line.179"></a>
<span class="sourceLineNo">180</span> final String[] pathFrags = QUERY_STRING_PATTERN.split(elements[1]);<a name="line.180"></a>
<span class="sourceLineNo">181</span> final String requestedPath = pathFrags[0];<a name="line.181"></a>
<span class="sourceLineNo">182</span> final String queryString = pathFrags.length == 2 ? pathFrags[1] : "";<a name="line.182"></a>
<span class="sourceLineNo">183</span><a name="line.183"></a>
<span class="sourceLineNo">184</span> // we put the buffer position where we found the beginning of the HTTP body<a name="line.184"></a>
<span class="sourceLineNo">185</span> buffer.position(headersAndBody[0].length() + 4);<a name="line.185"></a>
<span class="sourceLineNo">186</span><a name="line.186"></a>
<span class="sourceLineNo">187</span> return new HttpRequestImpl(version, method, requestedPath, queryString, generalHeaders);<a name="line.187"></a>
<span class="sourceLineNo">188</span> }<a name="line.188"></a>
<span class="sourceLineNo">189</span>}<a name="line.189"></a>
</pre>
</div>
</body>
</html>