| <!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>package org.apache.shiro.web.util;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span><a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import org.apache.shiro.SecurityUtils;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import org.apache.shiro.session.Session;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.apache.shiro.subject.Subject;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.apache.shiro.subject.support.DefaultSubjectContext;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.shiro.util.StringUtils;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.shiro.web.env.EnvironmentLoader;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.shiro.web.env.WebEnvironment;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.shiro.web.filter.AccessControlFilter;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.slf4j.Logger;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import org.slf4j.LoggerFactory;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span><a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import javax.servlet.ServletContext;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import javax.servlet.ServletRequest;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>import javax.servlet.ServletResponse;<a name="line.34"></a> |
| <span class="sourceLineNo">035</span>import javax.servlet.http.HttpServletRequest;<a name="line.35"></a> |
| <span class="sourceLineNo">036</span>import javax.servlet.http.HttpServletResponse;<a name="line.36"></a> |
| <span class="sourceLineNo">037</span>import java.io.IOException;<a name="line.37"></a> |
| <span class="sourceLineNo">038</span>import java.io.UnsupportedEncodingException;<a name="line.38"></a> |
| <span class="sourceLineNo">039</span>import java.net.URLDecoder;<a name="line.39"></a> |
| <span class="sourceLineNo">040</span>import java.util.Map;<a name="line.40"></a> |
| <span class="sourceLineNo">041</span><a name="line.41"></a> |
| <span class="sourceLineNo">042</span>/**<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * Simple utility class for operations used across multiple class hierarchies in the web framework code.<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * <p/><a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * Some methods in this class were copied from the Spring Framework so we didn't have to re-invent the wheel,<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * and in these cases, we have retained all license, copyright and author information.<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> *<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * @since 0.9<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> */<a name="line.49"></a> |
| <span class="sourceLineNo">050</span>public class WebUtils {<a name="line.50"></a> |
| <span class="sourceLineNo">051</span><a name="line.51"></a> |
| <span class="sourceLineNo">052</span> //TODO - complete JavaDoc<a name="line.52"></a> |
| <span class="sourceLineNo">053</span><a name="line.53"></a> |
| <span class="sourceLineNo">054</span> private static final Logger log = LoggerFactory.getLogger(WebUtils.class);<a name="line.54"></a> |
| <span class="sourceLineNo">055</span><a name="line.55"></a> |
| <span class="sourceLineNo">056</span> public static final String SERVLET_REQUEST_KEY = ServletRequest.class.getName() + "_SHIRO_THREAD_CONTEXT_KEY";<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> public static final String SERVLET_RESPONSE_KEY = ServletResponse.class.getName() + "_SHIRO_THREAD_CONTEXT_KEY";<a name="line.57"></a> |
| <span class="sourceLineNo">058</span><a name="line.58"></a> |
| <span class="sourceLineNo">059</span> /**<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> * {@link org.apache.shiro.session.Session Session} key used to save a request and later restore it, for example when redirecting to a<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> * requested page after login, equal to {@code shiroSavedRequest}.<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> */<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> public static final String SAVED_REQUEST_KEY = "shiroSavedRequest";<a name="line.63"></a> |
| <span class="sourceLineNo">064</span><a name="line.64"></a> |
| <span class="sourceLineNo">065</span> /**<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> * Standard Servlet 2.3+ spec request attributes for include URI and paths.<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> * <p>If included via a RequestDispatcher, the current resource will see the<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> * originating request. Its own URI and paths are exposed as request attributes.<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> */<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> public static final String INCLUDE_REQUEST_URI_ATTRIBUTE = "javax.servlet.include.request_uri";<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> public static final String INCLUDE_CONTEXT_PATH_ATTRIBUTE = "javax.servlet.include.context_path";<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> public static final String INCLUDE_SERVLET_PATH_ATTRIBUTE = "javax.servlet.include.servlet_path";<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> public static final String INCLUDE_PATH_INFO_ATTRIBUTE = "javax.servlet.include.path_info";<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> public static final String INCLUDE_QUERY_STRING_ATTRIBUTE = "javax.servlet.include.query_string";<a name="line.74"></a> |
| <span class="sourceLineNo">075</span><a name="line.75"></a> |
| <span class="sourceLineNo">076</span> /**<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> * Standard Servlet 2.4+ spec request attributes for forward URI and paths.<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> * <p>If forwarded to via a RequestDispatcher, the current resource will see its<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * own URI and paths. The originating URI and paths are exposed as request attributes.<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> */<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> public static final String FORWARD_REQUEST_URI_ATTRIBUTE = "javax.servlet.forward.request_uri";<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> public static final String FORWARD_CONTEXT_PATH_ATTRIBUTE = "javax.servlet.forward.context_path";<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> public static final String FORWARD_SERVLET_PATH_ATTRIBUTE = "javax.servlet.forward.servlet_path";<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> public static final String FORWARD_PATH_INFO_ATTRIBUTE = "javax.servlet.forward.path_info";<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> public static final String FORWARD_QUERY_STRING_ATTRIBUTE = "javax.servlet.forward.query_string";<a name="line.85"></a> |
| <span class="sourceLineNo">086</span><a name="line.86"></a> |
| <span class="sourceLineNo">087</span> /**<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> * Default character encoding to use when <code>request.getCharacterEncoding</code><a name="line.88"></a> |
| <span class="sourceLineNo">089</span> * returns <code>null</code>, according to the Servlet spec.<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> *<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> * @see javax.servlet.ServletRequest#getCharacterEncoding<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> */<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> public static final String DEFAULT_CHARACTER_ENCODING = "ISO-8859-1";<a name="line.93"></a> |
| <span class="sourceLineNo">094</span><a name="line.94"></a> |
| <span class="sourceLineNo">095</span> /**<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> * Return the path within the web application for the given request.<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> * Detects include request URL if called within a RequestDispatcher include.<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> * <p/><a name="line.98"></a> |
| <span class="sourceLineNo">099</span> * For example, for a request to URL<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> * <p/><a name="line.100"></a> |
| <span class="sourceLineNo">101</span> * <code>http://www.somehost.com/myapp/my/url.jsp</code>,<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> * <p/><a name="line.102"></a> |
| <span class="sourceLineNo">103</span> * for an application deployed to <code>/mayapp</code> (the application's context path), this method would return<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> * <p/><a name="line.104"></a> |
| <span class="sourceLineNo">105</span> * <code>/my/url.jsp</code>.<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> *<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> * @param request current HTTP request<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> * @return the path within the web application<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> */<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> public static String getPathWithinApplication(HttpServletRequest request) {<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> String contextPath = getContextPath(request);<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> String requestUri = getRequestUri(request);<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> if (StringUtils.startsWithIgnoreCase(requestUri, contextPath)) {<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> // Normal case: URI contains context path.<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> String path = requestUri.substring(contextPath.length());<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> return (StringUtils.hasText(path) ? path : "/");<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> } else {<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> // Special case: rather unusual.<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> return requestUri;<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> }<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> }<a name="line.121"></a> |
| <span class="sourceLineNo">122</span><a name="line.122"></a> |
| <span class="sourceLineNo">123</span> /**<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> * Return the request URI for the given request, detecting an include request<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> * URL if called within a RequestDispatcher include.<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> * <p>As the value returned by <code>request.getRequestURI()</code> is <i>not</i><a name="line.126"></a> |
| <span class="sourceLineNo">127</span> * decoded by the servlet container, this method will decode it.<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> * <p>The URI that the web container resolves <i>should</i> be correct, but some<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> * containers like JBoss/Jetty incorrectly include ";" strings like ";jsessionid"<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> * in the URI. This method cuts off such incorrect appendices.<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> *<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> * @param request current HTTP request<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> * @return the request URI<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> */<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> public static String getRequestUri(HttpServletRequest request) {<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> String uri = (String) request.getAttribute(INCLUDE_REQUEST_URI_ATTRIBUTE);<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> if (uri == null) {<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> uri = request.getRequestURI();<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> }<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> return normalize(decodeAndCleanUriString(request, uri));<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> /**<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> * Normalize a relative URI path that may have relative values ("/./",<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> * "/../", and so on ) it it. <strong>WARNING</strong> - This method is<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> * useful only for normalizing application-generated paths. It does not<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> * try to perform security checks for malicious input.<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> * Normalize operations were was happily taken from org.apache.catalina.util.RequestUtil in<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> * Tomcat trunk, r939305<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> *<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> * @param path Relative path to be normalized<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> * @return normalized path<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> */<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> public static String normalize(String path) {<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> return normalize(path, true);<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> }<a name="line.156"></a> |
| <span class="sourceLineNo">157</span><a name="line.157"></a> |
| <span class="sourceLineNo">158</span> /**<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> * Normalize a relative URI path that may have relative values ("/./",<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> * "/../", and so on ) it it. <strong>WARNING</strong> - This method is<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> * useful only for normalizing application-generated paths. It does not<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> * try to perform security checks for malicious input.<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> * Normalize operations were was happily taken from org.apache.catalina.util.RequestUtil in<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> * Tomcat trunk, r939305<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> *<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> * @param path Relative path to be normalized<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> * @param replaceBackSlash Should '\\' be replaced with '/'<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> * @return normalized path<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> */<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> private static String normalize(String path, boolean replaceBackSlash) {<a name="line.170"></a> |
| <span class="sourceLineNo">171</span><a name="line.171"></a> |
| <span class="sourceLineNo">172</span> if (path == null)<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> return null;<a name="line.173"></a> |
| <span class="sourceLineNo">174</span><a name="line.174"></a> |
| <span class="sourceLineNo">175</span> // Create a place for the normalized path<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> String normalized = path;<a name="line.176"></a> |
| <span class="sourceLineNo">177</span><a name="line.177"></a> |
| <span class="sourceLineNo">178</span> if (replaceBackSlash && normalized.indexOf('\\') >= 0)<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> normalized = normalized.replace('\\', '/');<a name="line.179"></a> |
| <span class="sourceLineNo">180</span><a name="line.180"></a> |
| <span class="sourceLineNo">181</span> if (normalized.equals("/."))<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> return "/";<a name="line.182"></a> |
| <span class="sourceLineNo">183</span><a name="line.183"></a> |
| <span class="sourceLineNo">184</span> // Add a leading "/" if necessary<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> if (!normalized.startsWith("/"))<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> normalized = "/" + normalized;<a name="line.186"></a> |
| <span class="sourceLineNo">187</span><a name="line.187"></a> |
| <span class="sourceLineNo">188</span> // Resolve occurrences of "//" in the normalized path<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> while (true) {<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> int index = normalized.indexOf("//");<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> if (index < 0)<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> break;<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> normalized = normalized.substring(0, index) +<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> normalized.substring(index + 1);<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> }<a name="line.195"></a> |
| <span class="sourceLineNo">196</span><a name="line.196"></a> |
| <span class="sourceLineNo">197</span> // Resolve occurrences of "/./" in the normalized path<a name="line.197"></a> |
| <span class="sourceLineNo">198</span> while (true) {<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> int index = normalized.indexOf("/./");<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> if (index < 0)<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> break;<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> normalized = normalized.substring(0, index) +<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> normalized.substring(index + 2);<a name="line.203"></a> |
| <span class="sourceLineNo">204</span> }<a name="line.204"></a> |
| <span class="sourceLineNo">205</span><a name="line.205"></a> |
| <span class="sourceLineNo">206</span> // Resolve occurrences of "/../" in the normalized path<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> while (true) {<a name="line.207"></a> |
| <span class="sourceLineNo">208</span> int index = normalized.indexOf("/../");<a name="line.208"></a> |
| <span class="sourceLineNo">209</span> if (index < 0)<a name="line.209"></a> |
| <span class="sourceLineNo">210</span> break;<a name="line.210"></a> |
| <span class="sourceLineNo">211</span> if (index == 0)<a name="line.211"></a> |
| <span class="sourceLineNo">212</span> return (null); // Trying to go outside our context<a name="line.212"></a> |
| <span class="sourceLineNo">213</span> int index2 = normalized.lastIndexOf('/', index - 1);<a name="line.213"></a> |
| <span class="sourceLineNo">214</span> normalized = normalized.substring(0, index2) +<a name="line.214"></a> |
| <span class="sourceLineNo">215</span> normalized.substring(index + 3);<a name="line.215"></a> |
| <span class="sourceLineNo">216</span> }<a name="line.216"></a> |
| <span class="sourceLineNo">217</span><a name="line.217"></a> |
| <span class="sourceLineNo">218</span> // Return the normalized path that we have completed<a name="line.218"></a> |
| <span class="sourceLineNo">219</span> return (normalized);<a name="line.219"></a> |
| <span class="sourceLineNo">220</span><a name="line.220"></a> |
| <span class="sourceLineNo">221</span> }<a name="line.221"></a> |
| <span class="sourceLineNo">222</span><a name="line.222"></a> |
| <span class="sourceLineNo">223</span><a name="line.223"></a> |
| <span class="sourceLineNo">224</span> /**<a name="line.224"></a> |
| <span class="sourceLineNo">225</span> * Decode the supplied URI string and strips any extraneous portion after a ';'.<a name="line.225"></a> |
| <span class="sourceLineNo">226</span> *<a name="line.226"></a> |
| <span class="sourceLineNo">227</span> * @param request the incoming HttpServletRequest<a name="line.227"></a> |
| <span class="sourceLineNo">228</span> * @param uri the application's URI string<a name="line.228"></a> |
| <span class="sourceLineNo">229</span> * @return the supplied URI string stripped of any extraneous portion after a ';'.<a name="line.229"></a> |
| <span class="sourceLineNo">230</span> */<a name="line.230"></a> |
| <span class="sourceLineNo">231</span> private static String decodeAndCleanUriString(HttpServletRequest request, String uri) {<a name="line.231"></a> |
| <span class="sourceLineNo">232</span> uri = decodeRequestString(request, uri);<a name="line.232"></a> |
| <span class="sourceLineNo">233</span> int semicolonIndex = uri.indexOf(';');<a name="line.233"></a> |
| <span class="sourceLineNo">234</span> return (semicolonIndex != -1 ? uri.substring(0, semicolonIndex) : uri);<a name="line.234"></a> |
| <span class="sourceLineNo">235</span> }<a name="line.235"></a> |
| <span class="sourceLineNo">236</span><a name="line.236"></a> |
| <span class="sourceLineNo">237</span> /**<a name="line.237"></a> |
| <span class="sourceLineNo">238</span> * Return the context path for the given request, detecting an include request<a name="line.238"></a> |
| <span class="sourceLineNo">239</span> * URL if called within a RequestDispatcher include.<a name="line.239"></a> |
| <span class="sourceLineNo">240</span> * <p>As the value returned by <code>request.getContextPath()</code> is <i>not</i><a name="line.240"></a> |
| <span class="sourceLineNo">241</span> * decoded by the servlet container, this method will decode it.<a name="line.241"></a> |
| <span class="sourceLineNo">242</span> *<a name="line.242"></a> |
| <span class="sourceLineNo">243</span> * @param request current HTTP request<a name="line.243"></a> |
| <span class="sourceLineNo">244</span> * @return the context path<a name="line.244"></a> |
| <span class="sourceLineNo">245</span> */<a name="line.245"></a> |
| <span class="sourceLineNo">246</span> public static String getContextPath(HttpServletRequest request) {<a name="line.246"></a> |
| <span class="sourceLineNo">247</span> String contextPath = (String) request.getAttribute(INCLUDE_CONTEXT_PATH_ATTRIBUTE);<a name="line.247"></a> |
| <span class="sourceLineNo">248</span> if (contextPath == null) {<a name="line.248"></a> |
| <span class="sourceLineNo">249</span> contextPath = request.getContextPath();<a name="line.249"></a> |
| <span class="sourceLineNo">250</span> }<a name="line.250"></a> |
| <span class="sourceLineNo">251</span> if ("/".equals(contextPath)) {<a name="line.251"></a> |
| <span class="sourceLineNo">252</span> // Invalid case, but happens for includes on Jetty: silently adapt it.<a name="line.252"></a> |
| <span class="sourceLineNo">253</span> contextPath = "";<a name="line.253"></a> |
| <span class="sourceLineNo">254</span> }<a name="line.254"></a> |
| <span class="sourceLineNo">255</span> return decodeRequestString(request, contextPath);<a name="line.255"></a> |
| <span class="sourceLineNo">256</span> }<a name="line.256"></a> |
| <span class="sourceLineNo">257</span><a name="line.257"></a> |
| <span class="sourceLineNo">258</span> /**<a name="line.258"></a> |
| <span class="sourceLineNo">259</span> * Find the Shiro {@link WebEnvironment} for this web application, which is typically loaded via the<a name="line.259"></a> |
| <span class="sourceLineNo">260</span> * {@link org.apache.shiro.web.env.EnvironmentLoaderListener}.<a name="line.260"></a> |
| <span class="sourceLineNo">261</span> * <p/><a name="line.261"></a> |
| <span class="sourceLineNo">262</span> * This implementation rethrows an exception that happened on environment startup to differentiate between a failed<a name="line.262"></a> |
| <span class="sourceLineNo">263</span> * environment startup and no environment at all.<a name="line.263"></a> |
| <span class="sourceLineNo">264</span> *<a name="line.264"></a> |
| <span class="sourceLineNo">265</span> * @param sc ServletContext to find the web application context for<a name="line.265"></a> |
| <span class="sourceLineNo">266</span> * @return the root WebApplicationContext for this web app<a name="line.266"></a> |
| <span class="sourceLineNo">267</span> * @throws IllegalStateException if the root WebApplicationContext could not be found<a name="line.267"></a> |
| <span class="sourceLineNo">268</span> * @see org.apache.shiro.web.env.EnvironmentLoader#ENVIRONMENT_ATTRIBUTE_KEY<a name="line.268"></a> |
| <span class="sourceLineNo">269</span> * @since 1.2<a name="line.269"></a> |
| <span class="sourceLineNo">270</span> */<a name="line.270"></a> |
| <span class="sourceLineNo">271</span> public static WebEnvironment getRequiredWebEnvironment(ServletContext sc)<a name="line.271"></a> |
| <span class="sourceLineNo">272</span> throws IllegalStateException {<a name="line.272"></a> |
| <span class="sourceLineNo">273</span><a name="line.273"></a> |
| <span class="sourceLineNo">274</span> WebEnvironment we = getWebEnvironment(sc);<a name="line.274"></a> |
| <span class="sourceLineNo">275</span> if (we == null) {<a name="line.275"></a> |
| <span class="sourceLineNo">276</span> throw new IllegalStateException("No WebEnvironment found: no EnvironmentLoaderListener registered?");<a name="line.276"></a> |
| <span class="sourceLineNo">277</span> }<a name="line.277"></a> |
| <span class="sourceLineNo">278</span> return we;<a name="line.278"></a> |
| <span class="sourceLineNo">279</span> }<a name="line.279"></a> |
| <span class="sourceLineNo">280</span><a name="line.280"></a> |
| <span class="sourceLineNo">281</span> /**<a name="line.281"></a> |
| <span class="sourceLineNo">282</span> * Find the Shiro {@link WebEnvironment} for this web application, which is typically loaded via<a name="line.282"></a> |
| <span class="sourceLineNo">283</span> * {@link org.apache.shiro.web.env.EnvironmentLoaderListener}.<a name="line.283"></a> |
| <span class="sourceLineNo">284</span> * <p/><a name="line.284"></a> |
| <span class="sourceLineNo">285</span> * This implementation rethrows an exception that happened on environment startup to differentiate between a failed<a name="line.285"></a> |
| <span class="sourceLineNo">286</span> * environment startup and no environment at all.<a name="line.286"></a> |
| <span class="sourceLineNo">287</span> *<a name="line.287"></a> |
| <span class="sourceLineNo">288</span> * @param sc ServletContext to find the web application context for<a name="line.288"></a> |
| <span class="sourceLineNo">289</span> * @return the root WebApplicationContext for this web app, or <code>null</code> if none<a name="line.289"></a> |
| <span class="sourceLineNo">290</span> * @see org.apache.shiro.web.env.EnvironmentLoader#ENVIRONMENT_ATTRIBUTE_KEY<a name="line.290"></a> |
| <span class="sourceLineNo">291</span> * @since 1.2<a name="line.291"></a> |
| <span class="sourceLineNo">292</span> */<a name="line.292"></a> |
| <span class="sourceLineNo">293</span> public static WebEnvironment getWebEnvironment(ServletContext sc) {<a name="line.293"></a> |
| <span class="sourceLineNo">294</span> return getWebEnvironment(sc, EnvironmentLoader.ENVIRONMENT_ATTRIBUTE_KEY);<a name="line.294"></a> |
| <span class="sourceLineNo">295</span> }<a name="line.295"></a> |
| <span class="sourceLineNo">296</span><a name="line.296"></a> |
| <span class="sourceLineNo">297</span> /**<a name="line.297"></a> |
| <span class="sourceLineNo">298</span> * Find the Shiro {@link WebEnvironment} for this web application.<a name="line.298"></a> |
| <span class="sourceLineNo">299</span> *<a name="line.299"></a> |
| <span class="sourceLineNo">300</span> * @param sc ServletContext to find the web application context for<a name="line.300"></a> |
| <span class="sourceLineNo">301</span> * @param attrName the name of the ServletContext attribute to look for<a name="line.301"></a> |
| <span class="sourceLineNo">302</span> * @return the desired WebEnvironment for this web app, or <code>null</code> if none<a name="line.302"></a> |
| <span class="sourceLineNo">303</span> * @since 1.2<a name="line.303"></a> |
| <span class="sourceLineNo">304</span> */<a name="line.304"></a> |
| <span class="sourceLineNo">305</span> public static WebEnvironment getWebEnvironment(ServletContext sc, String attrName) {<a name="line.305"></a> |
| <span class="sourceLineNo">306</span> if (sc == null) {<a name="line.306"></a> |
| <span class="sourceLineNo">307</span> throw new IllegalArgumentException("ServletContext argument must not be null.");<a name="line.307"></a> |
| <span class="sourceLineNo">308</span> }<a name="line.308"></a> |
| <span class="sourceLineNo">309</span> Object attr = sc.getAttribute(attrName);<a name="line.309"></a> |
| <span class="sourceLineNo">310</span> if (attr == null) {<a name="line.310"></a> |
| <span class="sourceLineNo">311</span> return null;<a name="line.311"></a> |
| <span class="sourceLineNo">312</span> }<a name="line.312"></a> |
| <span class="sourceLineNo">313</span> if (attr instanceof RuntimeException) {<a name="line.313"></a> |
| <span class="sourceLineNo">314</span> throw (RuntimeException) attr;<a name="line.314"></a> |
| <span class="sourceLineNo">315</span> }<a name="line.315"></a> |
| <span class="sourceLineNo">316</span> if (attr instanceof Error) {<a name="line.316"></a> |
| <span class="sourceLineNo">317</span> throw (Error) attr;<a name="line.317"></a> |
| <span class="sourceLineNo">318</span> }<a name="line.318"></a> |
| <span class="sourceLineNo">319</span> if (attr instanceof Exception) {<a name="line.319"></a> |
| <span class="sourceLineNo">320</span> throw new IllegalStateException((Exception) attr);<a name="line.320"></a> |
| <span class="sourceLineNo">321</span> }<a name="line.321"></a> |
| <span class="sourceLineNo">322</span> if (!(attr instanceof WebEnvironment)) {<a name="line.322"></a> |
| <span class="sourceLineNo">323</span> throw new IllegalStateException("Context attribute is not of type WebEnvironment: " + attr);<a name="line.323"></a> |
| <span class="sourceLineNo">324</span> }<a name="line.324"></a> |
| <span class="sourceLineNo">325</span> return (WebEnvironment) attr;<a name="line.325"></a> |
| <span class="sourceLineNo">326</span> }<a name="line.326"></a> |
| <span class="sourceLineNo">327</span><a name="line.327"></a> |
| <span class="sourceLineNo">328</span><a name="line.328"></a> |
| <span class="sourceLineNo">329</span> /**<a name="line.329"></a> |
| <span class="sourceLineNo">330</span> * Decode the given source string with a URLDecoder. The encoding will be taken<a name="line.330"></a> |
| <span class="sourceLineNo">331</span> * from the request, falling back to the default "ISO-8859-1".<a name="line.331"></a> |
| <span class="sourceLineNo">332</span> * <p>The default implementation uses <code>URLDecoder.decode(input, enc)</code>.<a name="line.332"></a> |
| <span class="sourceLineNo">333</span> *<a name="line.333"></a> |
| <span class="sourceLineNo">334</span> * @param request current HTTP request<a name="line.334"></a> |
| <span class="sourceLineNo">335</span> * @param source the String to decode<a name="line.335"></a> |
| <span class="sourceLineNo">336</span> * @return the decoded String<a name="line.336"></a> |
| <span class="sourceLineNo">337</span> * @see #DEFAULT_CHARACTER_ENCODING<a name="line.337"></a> |
| <span class="sourceLineNo">338</span> * @see javax.servlet.ServletRequest#getCharacterEncoding<a name="line.338"></a> |
| <span class="sourceLineNo">339</span> * @see java.net.URLDecoder#decode(String, String)<a name="line.339"></a> |
| <span class="sourceLineNo">340</span> * @see java.net.URLDecoder#decode(String)<a name="line.340"></a> |
| <span class="sourceLineNo">341</span> */<a name="line.341"></a> |
| <span class="sourceLineNo">342</span> @SuppressWarnings({"deprecation"})<a name="line.342"></a> |
| <span class="sourceLineNo">343</span> public static String decodeRequestString(HttpServletRequest request, String source) {<a name="line.343"></a> |
| <span class="sourceLineNo">344</span> String enc = determineEncoding(request);<a name="line.344"></a> |
| <span class="sourceLineNo">345</span> try {<a name="line.345"></a> |
| <span class="sourceLineNo">346</span> return URLDecoder.decode(source, enc);<a name="line.346"></a> |
| <span class="sourceLineNo">347</span> } catch (UnsupportedEncodingException ex) {<a name="line.347"></a> |
| <span class="sourceLineNo">348</span> if (log.isWarnEnabled()) {<a name="line.348"></a> |
| <span class="sourceLineNo">349</span> log.warn("Could not decode request string [" + source + "] with encoding '" + enc +<a name="line.349"></a> |
| <span class="sourceLineNo">350</span> "': falling back to platform default encoding; exception message: " + ex.getMessage());<a name="line.350"></a> |
| <span class="sourceLineNo">351</span> }<a name="line.351"></a> |
| <span class="sourceLineNo">352</span> return URLDecoder.decode(source);<a name="line.352"></a> |
| <span class="sourceLineNo">353</span> }<a name="line.353"></a> |
| <span class="sourceLineNo">354</span> }<a name="line.354"></a> |
| <span class="sourceLineNo">355</span><a name="line.355"></a> |
| <span class="sourceLineNo">356</span> /**<a name="line.356"></a> |
| <span class="sourceLineNo">357</span> * Determine the encoding for the given request.<a name="line.357"></a> |
| <span class="sourceLineNo">358</span> * Can be overridden in subclasses.<a name="line.358"></a> |
| <span class="sourceLineNo">359</span> * <p>The default implementation checks the request's<a name="line.359"></a> |
| <span class="sourceLineNo">360</span> * {@link ServletRequest#getCharacterEncoding() character encoding}, and if that<a name="line.360"></a> |
| <span class="sourceLineNo">361</span> * <code>null</code>, falls back to the {@link #DEFAULT_CHARACTER_ENCODING}.<a name="line.361"></a> |
| <span class="sourceLineNo">362</span> *<a name="line.362"></a> |
| <span class="sourceLineNo">363</span> * @param request current HTTP request<a name="line.363"></a> |
| <span class="sourceLineNo">364</span> * @return the encoding for the request (never <code>null</code>)<a name="line.364"></a> |
| <span class="sourceLineNo">365</span> * @see javax.servlet.ServletRequest#getCharacterEncoding()<a name="line.365"></a> |
| <span class="sourceLineNo">366</span> */<a name="line.366"></a> |
| <span class="sourceLineNo">367</span> protected static String determineEncoding(HttpServletRequest request) {<a name="line.367"></a> |
| <span class="sourceLineNo">368</span> String enc = request.getCharacterEncoding();<a name="line.368"></a> |
| <span class="sourceLineNo">369</span> if (enc == null) {<a name="line.369"></a> |
| <span class="sourceLineNo">370</span> enc = DEFAULT_CHARACTER_ENCODING;<a name="line.370"></a> |
| <span class="sourceLineNo">371</span> }<a name="line.371"></a> |
| <span class="sourceLineNo">372</span> return enc;<a name="line.372"></a> |
| <span class="sourceLineNo">373</span> }<a name="line.373"></a> |
| <span class="sourceLineNo">374</span><a name="line.374"></a> |
| <span class="sourceLineNo">375</span> /*<a name="line.375"></a> |
| <span class="sourceLineNo">376</span> * Returns {@code true} IFF the specified {@code SubjectContext}:<a name="line.376"></a> |
| <span class="sourceLineNo">377</span> * <ol><a name="line.377"></a> |
| <span class="sourceLineNo">378</span> * <li>A {@link WebSubjectContext} instance</li><a name="line.378"></a> |
| <span class="sourceLineNo">379</span> * <li>The {@code WebSubjectContext}'s request/response pair are not null</li><a name="line.379"></a> |
| <span class="sourceLineNo">380</span> * <li>The request is an {@link HttpServletRequest} instance</li><a name="line.380"></a> |
| <span class="sourceLineNo">381</span> * <li>The response is an {@link HttpServletResponse} instance</li><a name="line.381"></a> |
| <span class="sourceLineNo">382</span> * </ol><a name="line.382"></a> |
| <span class="sourceLineNo">383</span> *<a name="line.383"></a> |
| <span class="sourceLineNo">384</span> * @param context the SubjectContext to check to see if it is HTTP compatible.<a name="line.384"></a> |
| <span class="sourceLineNo">385</span> * @return {@code true} IFF the specified context has HTTP request/response objects, {@code false} otherwise.<a name="line.385"></a> |
| <span class="sourceLineNo">386</span> * @since 1.0<a name="line.386"></a> |
| <span class="sourceLineNo">387</span> */<a name="line.387"></a> |
| <span class="sourceLineNo">388</span><a name="line.388"></a> |
| <span class="sourceLineNo">389</span> public static boolean isWeb(Object requestPairSource) {<a name="line.389"></a> |
| <span class="sourceLineNo">390</span> return requestPairSource instanceof RequestPairSource && isWeb((RequestPairSource) requestPairSource);<a name="line.390"></a> |
| <span class="sourceLineNo">391</span> }<a name="line.391"></a> |
| <span class="sourceLineNo">392</span><a name="line.392"></a> |
| <span class="sourceLineNo">393</span> public static boolean isHttp(Object requestPairSource) {<a name="line.393"></a> |
| <span class="sourceLineNo">394</span> return requestPairSource instanceof RequestPairSource && isHttp((RequestPairSource) requestPairSource);<a name="line.394"></a> |
| <span class="sourceLineNo">395</span> }<a name="line.395"></a> |
| <span class="sourceLineNo">396</span><a name="line.396"></a> |
| <span class="sourceLineNo">397</span> public static ServletRequest getRequest(Object requestPairSource) {<a name="line.397"></a> |
| <span class="sourceLineNo">398</span> if (requestPairSource instanceof RequestPairSource) {<a name="line.398"></a> |
| <span class="sourceLineNo">399</span> return ((RequestPairSource) requestPairSource).getServletRequest();<a name="line.399"></a> |
| <span class="sourceLineNo">400</span> }<a name="line.400"></a> |
| <span class="sourceLineNo">401</span> return null;<a name="line.401"></a> |
| <span class="sourceLineNo">402</span> }<a name="line.402"></a> |
| <span class="sourceLineNo">403</span><a name="line.403"></a> |
| <span class="sourceLineNo">404</span> public static ServletResponse getResponse(Object requestPairSource) {<a name="line.404"></a> |
| <span class="sourceLineNo">405</span> if (requestPairSource instanceof RequestPairSource) {<a name="line.405"></a> |
| <span class="sourceLineNo">406</span> return ((RequestPairSource) requestPairSource).getServletResponse();<a name="line.406"></a> |
| <span class="sourceLineNo">407</span> }<a name="line.407"></a> |
| <span class="sourceLineNo">408</span> return null;<a name="line.408"></a> |
| <span class="sourceLineNo">409</span> }<a name="line.409"></a> |
| <span class="sourceLineNo">410</span><a name="line.410"></a> |
| <span class="sourceLineNo">411</span> public static HttpServletRequest getHttpRequest(Object requestPairSource) {<a name="line.411"></a> |
| <span class="sourceLineNo">412</span> ServletRequest request = getRequest(requestPairSource);<a name="line.412"></a> |
| <span class="sourceLineNo">413</span> if (request instanceof HttpServletRequest) {<a name="line.413"></a> |
| <span class="sourceLineNo">414</span> return (HttpServletRequest) request;<a name="line.414"></a> |
| <span class="sourceLineNo">415</span> }<a name="line.415"></a> |
| <span class="sourceLineNo">416</span> return null;<a name="line.416"></a> |
| <span class="sourceLineNo">417</span> }<a name="line.417"></a> |
| <span class="sourceLineNo">418</span><a name="line.418"></a> |
| <span class="sourceLineNo">419</span> public static HttpServletResponse getHttpResponse(Object requestPairSource) {<a name="line.419"></a> |
| <span class="sourceLineNo">420</span> ServletResponse response = getResponse(requestPairSource);<a name="line.420"></a> |
| <span class="sourceLineNo">421</span> if (response instanceof HttpServletResponse) {<a name="line.421"></a> |
| <span class="sourceLineNo">422</span> return (HttpServletResponse) response;<a name="line.422"></a> |
| <span class="sourceLineNo">423</span> }<a name="line.423"></a> |
| <span class="sourceLineNo">424</span> return null;<a name="line.424"></a> |
| <span class="sourceLineNo">425</span> }<a name="line.425"></a> |
| <span class="sourceLineNo">426</span><a name="line.426"></a> |
| <span class="sourceLineNo">427</span> private static boolean isWeb(RequestPairSource source) {<a name="line.427"></a> |
| <span class="sourceLineNo">428</span> ServletRequest request = source.getServletRequest();<a name="line.428"></a> |
| <span class="sourceLineNo">429</span> ServletResponse response = source.getServletResponse();<a name="line.429"></a> |
| <span class="sourceLineNo">430</span> return request != null && response != null;<a name="line.430"></a> |
| <span class="sourceLineNo">431</span> }<a name="line.431"></a> |
| <span class="sourceLineNo">432</span><a name="line.432"></a> |
| <span class="sourceLineNo">433</span> private static boolean isHttp(RequestPairSource source) {<a name="line.433"></a> |
| <span class="sourceLineNo">434</span> ServletRequest request = source.getServletRequest();<a name="line.434"></a> |
| <span class="sourceLineNo">435</span> ServletResponse response = source.getServletResponse();<a name="line.435"></a> |
| <span class="sourceLineNo">436</span> return request instanceof HttpServletRequest && response instanceof HttpServletResponse;<a name="line.436"></a> |
| <span class="sourceLineNo">437</span> }<a name="line.437"></a> |
| <span class="sourceLineNo">438</span><a name="line.438"></a> |
| <span class="sourceLineNo">439</span> /**<a name="line.439"></a> |
| <span class="sourceLineNo">440</span> * Returns {@code true} if a session is allowed to be created for a subject-associated request, {@code false}<a name="line.440"></a> |
| <span class="sourceLineNo">441</span> * otherwise.<a name="line.441"></a> |
| <span class="sourceLineNo">442</span> * <p/><a name="line.442"></a> |
| <span class="sourceLineNo">443</span> * <b>This method exists for Shiro's internal framework needs and should never be called by Shiro end-users. It<a name="line.443"></a> |
| <span class="sourceLineNo">444</span> * could be changed/removed at any time.</b><a name="line.444"></a> |
| <span class="sourceLineNo">445</span> *<a name="line.445"></a> |
| <span class="sourceLineNo">446</span> * @param requestPairSource a {@link RequestPairSource} instance, almost always a<a name="line.446"></a> |
| <span class="sourceLineNo">447</span> * {@link org.apache.shiro.web.subject.WebSubject WebSubject} instance.<a name="line.447"></a> |
| <span class="sourceLineNo">448</span> * @return {@code true} if a session is allowed to be created for a subject-associated request, {@code false}<a name="line.448"></a> |
| <span class="sourceLineNo">449</span> * otherwise.<a name="line.449"></a> |
| <span class="sourceLineNo">450</span> */<a name="line.450"></a> |
| <span class="sourceLineNo">451</span> public static boolean _isSessionCreationEnabled(Object requestPairSource) {<a name="line.451"></a> |
| <span class="sourceLineNo">452</span> if (requestPairSource instanceof RequestPairSource) {<a name="line.452"></a> |
| <span class="sourceLineNo">453</span> RequestPairSource source = (RequestPairSource) requestPairSource;<a name="line.453"></a> |
| <span class="sourceLineNo">454</span> return _isSessionCreationEnabled(source.getServletRequest());<a name="line.454"></a> |
| <span class="sourceLineNo">455</span> }<a name="line.455"></a> |
| <span class="sourceLineNo">456</span> return true; //by default<a name="line.456"></a> |
| <span class="sourceLineNo">457</span> }<a name="line.457"></a> |
| <span class="sourceLineNo">458</span><a name="line.458"></a> |
| <span class="sourceLineNo">459</span> /**<a name="line.459"></a> |
| <span class="sourceLineNo">460</span> * Returns {@code true} if a session is allowed to be created for a subject-associated request, {@code false}<a name="line.460"></a> |
| <span class="sourceLineNo">461</span> * otherwise.<a name="line.461"></a> |
| <span class="sourceLineNo">462</span> * <p/><a name="line.462"></a> |
| <span class="sourceLineNo">463</span> * <b>This method exists for Shiro's internal framework needs and should never be called by Shiro end-users. It<a name="line.463"></a> |
| <span class="sourceLineNo">464</span> * could be changed/removed at any time.</b><a name="line.464"></a> |
| <span class="sourceLineNo">465</span> *<a name="line.465"></a> |
| <span class="sourceLineNo">466</span> * @param request incoming servlet request.<a name="line.466"></a> |
| <span class="sourceLineNo">467</span> * @return {@code true} if a session is allowed to be created for a subject-associated request, {@code false}<a name="line.467"></a> |
| <span class="sourceLineNo">468</span> * otherwise.<a name="line.468"></a> |
| <span class="sourceLineNo">469</span> */<a name="line.469"></a> |
| <span class="sourceLineNo">470</span> public static boolean _isSessionCreationEnabled(ServletRequest request) {<a name="line.470"></a> |
| <span class="sourceLineNo">471</span> if (request != null) {<a name="line.471"></a> |
| <span class="sourceLineNo">472</span> Object val = request.getAttribute(DefaultSubjectContext.SESSION_CREATION_ENABLED);<a name="line.472"></a> |
| <span class="sourceLineNo">473</span> if (val != null && val instanceof Boolean) {<a name="line.473"></a> |
| <span class="sourceLineNo">474</span> return (Boolean) val;<a name="line.474"></a> |
| <span class="sourceLineNo">475</span> }<a name="line.475"></a> |
| <span class="sourceLineNo">476</span> }<a name="line.476"></a> |
| <span class="sourceLineNo">477</span> return true; //by default<a name="line.477"></a> |
| <span class="sourceLineNo">478</span> }<a name="line.478"></a> |
| <span class="sourceLineNo">479</span><a name="line.479"></a> |
| <span class="sourceLineNo">480</span> /**<a name="line.480"></a> |
| <span class="sourceLineNo">481</span> * A convenience method that merely casts the incoming <code>ServletRequest</code> to an<a name="line.481"></a> |
| <span class="sourceLineNo">482</span> * <code>HttpServletRequest</code>:<a name="line.482"></a> |
| <span class="sourceLineNo">483</span> * <p/><a name="line.483"></a> |
| <span class="sourceLineNo">484</span> * <code>return (HttpServletRequest)request;</code><a name="line.484"></a> |
| <span class="sourceLineNo">485</span> * <p/><a name="line.485"></a> |
| <span class="sourceLineNo">486</span> * Logic could be changed in the future for logging or throwing an meaningful exception in<a name="line.486"></a> |
| <span class="sourceLineNo">487</span> * non HTTP request environments (e.g. Portlet API).<a name="line.487"></a> |
| <span class="sourceLineNo">488</span> *<a name="line.488"></a> |
| <span class="sourceLineNo">489</span> * @param request the incoming ServletRequest<a name="line.489"></a> |
| <span class="sourceLineNo">490</span> * @return the <code>request</code> argument casted to an <code>HttpServletRequest</code>.<a name="line.490"></a> |
| <span class="sourceLineNo">491</span> */<a name="line.491"></a> |
| <span class="sourceLineNo">492</span> public static HttpServletRequest toHttp(ServletRequest request) {<a name="line.492"></a> |
| <span class="sourceLineNo">493</span> return (HttpServletRequest) request;<a name="line.493"></a> |
| <span class="sourceLineNo">494</span> }<a name="line.494"></a> |
| <span class="sourceLineNo">495</span><a name="line.495"></a> |
| <span class="sourceLineNo">496</span> /**<a name="line.496"></a> |
| <span class="sourceLineNo">497</span> * A convenience method that merely casts the incoming <code>ServletResponse</code> to an<a name="line.497"></a> |
| <span class="sourceLineNo">498</span> * <code>HttpServletResponse</code>:<a name="line.498"></a> |
| <span class="sourceLineNo">499</span> * <p/><a name="line.499"></a> |
| <span class="sourceLineNo">500</span> * <code>return (HttpServletResponse)response;</code><a name="line.500"></a> |
| <span class="sourceLineNo">501</span> * <p/><a name="line.501"></a> |
| <span class="sourceLineNo">502</span> * Logic could be changed in the future for logging or throwing an meaningful exception in<a name="line.502"></a> |
| <span class="sourceLineNo">503</span> * non HTTP request environments (e.g. Portlet API).<a name="line.503"></a> |
| <span class="sourceLineNo">504</span> *<a name="line.504"></a> |
| <span class="sourceLineNo">505</span> * @param response the outgoing ServletResponse<a name="line.505"></a> |
| <span class="sourceLineNo">506</span> * @return the <code>response</code> argument casted to an <code>HttpServletResponse</code>.<a name="line.506"></a> |
| <span class="sourceLineNo">507</span> */<a name="line.507"></a> |
| <span class="sourceLineNo">508</span> public static HttpServletResponse toHttp(ServletResponse response) {<a name="line.508"></a> |
| <span class="sourceLineNo">509</span> return (HttpServletResponse) response;<a name="line.509"></a> |
| <span class="sourceLineNo">510</span> }<a name="line.510"></a> |
| <span class="sourceLineNo">511</span><a name="line.511"></a> |
| <span class="sourceLineNo">512</span> /**<a name="line.512"></a> |
| <span class="sourceLineNo">513</span> * Redirects the current request to a new URL based on the given parameters.<a name="line.513"></a> |
| <span class="sourceLineNo">514</span> *<a name="line.514"></a> |
| <span class="sourceLineNo">515</span> * @param request the servlet request.<a name="line.515"></a> |
| <span class="sourceLineNo">516</span> * @param response the servlet response.<a name="line.516"></a> |
| <span class="sourceLineNo">517</span> * @param url the URL to redirect the user to.<a name="line.517"></a> |
| <span class="sourceLineNo">518</span> * @param queryParams a map of parameters that should be set as request parameters for the new request.<a name="line.518"></a> |
| <span class="sourceLineNo">519</span> * @param contextRelative true if the URL is relative to the servlet context path, or false if the URL is absolute.<a name="line.519"></a> |
| <span class="sourceLineNo">520</span> * @param http10Compatible whether to stay compatible with HTTP 1.0 clients.<a name="line.520"></a> |
| <span class="sourceLineNo">521</span> * @throws java.io.IOException if thrown by response methods.<a name="line.521"></a> |
| <span class="sourceLineNo">522</span> */<a name="line.522"></a> |
| <span class="sourceLineNo">523</span> public static void issueRedirect(ServletRequest request, ServletResponse response, String url, Map queryParams, boolean contextRelative, boolean http10Compatible) throws IOException {<a name="line.523"></a> |
| <span class="sourceLineNo">524</span> RedirectView view = new RedirectView(url, contextRelative, http10Compatible);<a name="line.524"></a> |
| <span class="sourceLineNo">525</span> view.renderMergedOutputModel(queryParams, toHttp(request), toHttp(response));<a name="line.525"></a> |
| <span class="sourceLineNo">526</span> }<a name="line.526"></a> |
| <span class="sourceLineNo">527</span><a name="line.527"></a> |
| <span class="sourceLineNo">528</span> /**<a name="line.528"></a> |
| <span class="sourceLineNo">529</span> * Redirects the current request to a new URL based on the given parameters and default values<a name="line.529"></a> |
| <span class="sourceLineNo">530</span> * for unspecified parameters.<a name="line.530"></a> |
| <span class="sourceLineNo">531</span> *<a name="line.531"></a> |
| <span class="sourceLineNo">532</span> * @param request the servlet request.<a name="line.532"></a> |
| <span class="sourceLineNo">533</span> * @param response the servlet response.<a name="line.533"></a> |
| <span class="sourceLineNo">534</span> * @param url the URL to redirect the user to.<a name="line.534"></a> |
| <span class="sourceLineNo">535</span> * @throws java.io.IOException if thrown by response methods.<a name="line.535"></a> |
| <span class="sourceLineNo">536</span> */<a name="line.536"></a> |
| <span class="sourceLineNo">537</span> public static void issueRedirect(ServletRequest request, ServletResponse response, String url) throws IOException {<a name="line.537"></a> |
| <span class="sourceLineNo">538</span> issueRedirect(request, response, url, null, true, true);<a name="line.538"></a> |
| <span class="sourceLineNo">539</span> }<a name="line.539"></a> |
| <span class="sourceLineNo">540</span><a name="line.540"></a> |
| <span class="sourceLineNo">541</span> /**<a name="line.541"></a> |
| <span class="sourceLineNo">542</span> * Redirects the current request to a new URL based on the given parameters and default values<a name="line.542"></a> |
| <span class="sourceLineNo">543</span> * for unspecified parameters.<a name="line.543"></a> |
| <span class="sourceLineNo">544</span> *<a name="line.544"></a> |
| <span class="sourceLineNo">545</span> * @param request the servlet request.<a name="line.545"></a> |
| <span class="sourceLineNo">546</span> * @param response the servlet response.<a name="line.546"></a> |
| <span class="sourceLineNo">547</span> * @param url the URL to redirect the user to.<a name="line.547"></a> |
| <span class="sourceLineNo">548</span> * @param queryParams a map of parameters that should be set as request parameters for the new request.<a name="line.548"></a> |
| <span class="sourceLineNo">549</span> * @throws java.io.IOException if thrown by response methods.<a name="line.549"></a> |
| <span class="sourceLineNo">550</span> */<a name="line.550"></a> |
| <span class="sourceLineNo">551</span> public static void issueRedirect(ServletRequest request, ServletResponse response, String url, Map queryParams) throws IOException {<a name="line.551"></a> |
| <span class="sourceLineNo">552</span> issueRedirect(request, response, url, queryParams, true, true);<a name="line.552"></a> |
| <span class="sourceLineNo">553</span> }<a name="line.553"></a> |
| <span class="sourceLineNo">554</span><a name="line.554"></a> |
| <span class="sourceLineNo">555</span> /**<a name="line.555"></a> |
| <span class="sourceLineNo">556</span> * Redirects the current request to a new URL based on the given parameters and default values<a name="line.556"></a> |
| <span class="sourceLineNo">557</span> * for unspecified parameters.<a name="line.557"></a> |
| <span class="sourceLineNo">558</span> *<a name="line.558"></a> |
| <span class="sourceLineNo">559</span> * @param request the servlet request.<a name="line.559"></a> |
| <span class="sourceLineNo">560</span> * @param response the servlet response.<a name="line.560"></a> |
| <span class="sourceLineNo">561</span> * @param url the URL to redirect the user to.<a name="line.561"></a> |
| <span class="sourceLineNo">562</span> * @param queryParams a map of parameters that should be set as request parameters for the new request.<a name="line.562"></a> |
| <span class="sourceLineNo">563</span> * @param contextRelative true if the URL is relative to the servlet context path, or false if the URL is absolute.<a name="line.563"></a> |
| <span class="sourceLineNo">564</span> * @throws java.io.IOException if thrown by response methods.<a name="line.564"></a> |
| <span class="sourceLineNo">565</span> */<a name="line.565"></a> |
| <span class="sourceLineNo">566</span> public static void issueRedirect(ServletRequest request, ServletResponse response, String url, Map queryParams, boolean contextRelative) throws IOException {<a name="line.566"></a> |
| <span class="sourceLineNo">567</span> issueRedirect(request, response, url, queryParams, contextRelative, true);<a name="line.567"></a> |
| <span class="sourceLineNo">568</span> }<a name="line.568"></a> |
| <span class="sourceLineNo">569</span><a name="line.569"></a> |
| <span class="sourceLineNo">570</span> /**<a name="line.570"></a> |
| <span class="sourceLineNo">571</span> * <p>Checks to see if a request param is considered true using a loose matching strategy for<a name="line.571"></a> |
| <span class="sourceLineNo">572</span> * general values that indicate that something is true or enabled, etc.</p><a name="line.572"></a> |
| <span class="sourceLineNo">573</span> * <p/><a name="line.573"></a> |
| <span class="sourceLineNo">574</span> * <p>Values that are considered "true" include (case-insensitive): true, t, 1, enabled, y, yes, on.</p><a name="line.574"></a> |
| <span class="sourceLineNo">575</span> *<a name="line.575"></a> |
| <span class="sourceLineNo">576</span> * @param request the servlet request<a name="line.576"></a> |
| <span class="sourceLineNo">577</span> * @param paramName @return true if the param value is considered true or false if it isn't.<a name="line.577"></a> |
| <span class="sourceLineNo">578</span> * @return true if the given parameter is considered "true" - false otherwise.<a name="line.578"></a> |
| <span class="sourceLineNo">579</span> */<a name="line.579"></a> |
| <span class="sourceLineNo">580</span> public static boolean isTrue(ServletRequest request, String paramName) {<a name="line.580"></a> |
| <span class="sourceLineNo">581</span> String value = getCleanParam(request, paramName);<a name="line.581"></a> |
| <span class="sourceLineNo">582</span> return value != null &&<a name="line.582"></a> |
| <span class="sourceLineNo">583</span> (value.equalsIgnoreCase("true") ||<a name="line.583"></a> |
| <span class="sourceLineNo">584</span> value.equalsIgnoreCase("t") ||<a name="line.584"></a> |
| <span class="sourceLineNo">585</span> value.equalsIgnoreCase("1") ||<a name="line.585"></a> |
| <span class="sourceLineNo">586</span> value.equalsIgnoreCase("enabled") ||<a name="line.586"></a> |
| <span class="sourceLineNo">587</span> value.equalsIgnoreCase("y") ||<a name="line.587"></a> |
| <span class="sourceLineNo">588</span> value.equalsIgnoreCase("yes") ||<a name="line.588"></a> |
| <span class="sourceLineNo">589</span> value.equalsIgnoreCase("on"));<a name="line.589"></a> |
| <span class="sourceLineNo">590</span> }<a name="line.590"></a> |
| <span class="sourceLineNo">591</span><a name="line.591"></a> |
| <span class="sourceLineNo">592</span> /**<a name="line.592"></a> |
| <span class="sourceLineNo">593</span> * Convenience method that returns a request parameter value, first running it through<a name="line.593"></a> |
| <span class="sourceLineNo">594</span> * {@link StringUtils#clean(String)}.<a name="line.594"></a> |
| <span class="sourceLineNo">595</span> *<a name="line.595"></a> |
| <span class="sourceLineNo">596</span> * @param request the servlet request.<a name="line.596"></a> |
| <span class="sourceLineNo">597</span> * @param paramName the parameter name.<a name="line.597"></a> |
| <span class="sourceLineNo">598</span> * @return the clean param value, or null if the param does not exist or is empty.<a name="line.598"></a> |
| <span class="sourceLineNo">599</span> */<a name="line.599"></a> |
| <span class="sourceLineNo">600</span> public static String getCleanParam(ServletRequest request, String paramName) {<a name="line.600"></a> |
| <span class="sourceLineNo">601</span> return StringUtils.clean(request.getParameter(paramName));<a name="line.601"></a> |
| <span class="sourceLineNo">602</span> }<a name="line.602"></a> |
| <span class="sourceLineNo">603</span><a name="line.603"></a> |
| <span class="sourceLineNo">604</span> public static void saveRequest(ServletRequest request) {<a name="line.604"></a> |
| <span class="sourceLineNo">605</span> Subject subject = SecurityUtils.getSubject();<a name="line.605"></a> |
| <span class="sourceLineNo">606</span> Session session = subject.getSession();<a name="line.606"></a> |
| <span class="sourceLineNo">607</span> HttpServletRequest httpRequest = toHttp(request);<a name="line.607"></a> |
| <span class="sourceLineNo">608</span> SavedRequest savedRequest = new SavedRequest(httpRequest);<a name="line.608"></a> |
| <span class="sourceLineNo">609</span> session.setAttribute(SAVED_REQUEST_KEY, savedRequest);<a name="line.609"></a> |
| <span class="sourceLineNo">610</span> }<a name="line.610"></a> |
| <span class="sourceLineNo">611</span><a name="line.611"></a> |
| <span class="sourceLineNo">612</span> public static SavedRequest getAndClearSavedRequest(ServletRequest request) {<a name="line.612"></a> |
| <span class="sourceLineNo">613</span> SavedRequest savedRequest = getSavedRequest(request);<a name="line.613"></a> |
| <span class="sourceLineNo">614</span> if (savedRequest != null) {<a name="line.614"></a> |
| <span class="sourceLineNo">615</span> Subject subject = SecurityUtils.getSubject();<a name="line.615"></a> |
| <span class="sourceLineNo">616</span> Session session = subject.getSession();<a name="line.616"></a> |
| <span class="sourceLineNo">617</span> session.removeAttribute(SAVED_REQUEST_KEY);<a name="line.617"></a> |
| <span class="sourceLineNo">618</span> }<a name="line.618"></a> |
| <span class="sourceLineNo">619</span> return savedRequest;<a name="line.619"></a> |
| <span class="sourceLineNo">620</span> }<a name="line.620"></a> |
| <span class="sourceLineNo">621</span><a name="line.621"></a> |
| <span class="sourceLineNo">622</span> public static SavedRequest getSavedRequest(ServletRequest request) {<a name="line.622"></a> |
| <span class="sourceLineNo">623</span> SavedRequest savedRequest = null;<a name="line.623"></a> |
| <span class="sourceLineNo">624</span> Subject subject = SecurityUtils.getSubject();<a name="line.624"></a> |
| <span class="sourceLineNo">625</span> Session session = subject.getSession(false);<a name="line.625"></a> |
| <span class="sourceLineNo">626</span> if (session != null) {<a name="line.626"></a> |
| <span class="sourceLineNo">627</span> savedRequest = (SavedRequest) session.getAttribute(SAVED_REQUEST_KEY);<a name="line.627"></a> |
| <span class="sourceLineNo">628</span> }<a name="line.628"></a> |
| <span class="sourceLineNo">629</span> return savedRequest;<a name="line.629"></a> |
| <span class="sourceLineNo">630</span> }<a name="line.630"></a> |
| <span class="sourceLineNo">631</span><a name="line.631"></a> |
| <span class="sourceLineNo">632</span> /**<a name="line.632"></a> |
| <span class="sourceLineNo">633</span> * Redirects the to the request url from a previously<a name="line.633"></a> |
| <span class="sourceLineNo">634</span> * {@link #saveRequest(javax.servlet.ServletRequest) saved} request, or if there is no saved request, redirects the<a name="line.634"></a> |
| <span class="sourceLineNo">635</span> * end user to the specified {@code fallbackUrl}. If there is no saved request or fallback url, this method<a name="line.635"></a> |
| <span class="sourceLineNo">636</span> * throws an {@link IllegalStateException}.<a name="line.636"></a> |
| <span class="sourceLineNo">637</span> * <p/><a name="line.637"></a> |
| <span class="sourceLineNo">638</span> * This method is primarily used to support a common login scenario - if an unauthenticated user accesses a<a name="line.638"></a> |
| <span class="sourceLineNo">639</span> * page that requires authentication, it is expected that request is<a name="line.639"></a> |
| <span class="sourceLineNo">640</span> * {@link #saveRequest(javax.servlet.ServletRequest) saved} first and then redirected to the login page. Then,<a name="line.640"></a> |
| <span class="sourceLineNo">641</span> * after a successful login, this method can be called to redirect them back to their originally requested URL, a<a name="line.641"></a> |
| <span class="sourceLineNo">642</span> * nice usability feature.<a name="line.642"></a> |
| <span class="sourceLineNo">643</span> *<a name="line.643"></a> |
| <span class="sourceLineNo">644</span> * @param request the incoming request<a name="line.644"></a> |
| <span class="sourceLineNo">645</span> * @param response the outgoing response<a name="line.645"></a> |
| <span class="sourceLineNo">646</span> * @param fallbackUrl the fallback url to redirect to if there is no saved request available.<a name="line.646"></a> |
| <span class="sourceLineNo">647</span> * @throws IllegalStateException if there is no saved request and the {@code fallbackUrl} is {@code null}.<a name="line.647"></a> |
| <span class="sourceLineNo">648</span> * @throws IOException if there is an error redirecting<a name="line.648"></a> |
| <span class="sourceLineNo">649</span> * @since 1.0<a name="line.649"></a> |
| <span class="sourceLineNo">650</span> */<a name="line.650"></a> |
| <span class="sourceLineNo">651</span> public static void redirectToSavedRequest(ServletRequest request, ServletResponse response, String fallbackUrl)<a name="line.651"></a> |
| <span class="sourceLineNo">652</span> throws IOException {<a name="line.652"></a> |
| <span class="sourceLineNo">653</span> String successUrl = null;<a name="line.653"></a> |
| <span class="sourceLineNo">654</span> boolean contextRelative = true;<a name="line.654"></a> |
| <span class="sourceLineNo">655</span> SavedRequest savedRequest = WebUtils.getAndClearSavedRequest(request);<a name="line.655"></a> |
| <span class="sourceLineNo">656</span> if (savedRequest != null && savedRequest.getMethod().equalsIgnoreCase(AccessControlFilter.GET_METHOD)) {<a name="line.656"></a> |
| <span class="sourceLineNo">657</span> successUrl = savedRequest.getRequestUrl();<a name="line.657"></a> |
| <span class="sourceLineNo">658</span> contextRelative = false;<a name="line.658"></a> |
| <span class="sourceLineNo">659</span> }<a name="line.659"></a> |
| <span class="sourceLineNo">660</span><a name="line.660"></a> |
| <span class="sourceLineNo">661</span> if (successUrl == null) {<a name="line.661"></a> |
| <span class="sourceLineNo">662</span> successUrl = fallbackUrl;<a name="line.662"></a> |
| <span class="sourceLineNo">663</span> }<a name="line.663"></a> |
| <span class="sourceLineNo">664</span><a name="line.664"></a> |
| <span class="sourceLineNo">665</span> if (successUrl == null) {<a name="line.665"></a> |
| <span class="sourceLineNo">666</span> throw new IllegalStateException("Success URL not available via saved request or via the " +<a name="line.666"></a> |
| <span class="sourceLineNo">667</span> "successUrlFallback method parameter. One of these must be non-null for " +<a name="line.667"></a> |
| <span class="sourceLineNo">668</span> "issueSuccessRedirect() to work.");<a name="line.668"></a> |
| <span class="sourceLineNo">669</span> }<a name="line.669"></a> |
| <span class="sourceLineNo">670</span><a name="line.670"></a> |
| <span class="sourceLineNo">671</span> WebUtils.issueRedirect(request, response, successUrl, null, contextRelative);<a name="line.671"></a> |
| <span class="sourceLineNo">672</span> }<a name="line.672"></a> |
| <span class="sourceLineNo">673</span><a name="line.673"></a> |
| <span class="sourceLineNo">674</span>}<a name="line.674"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
