| <HTML> |
| <BODY BGCOLOR="white"> |
| <PRE> |
| <FONT color="green">001</FONT> /*<a name="line.1"></a> |
| <FONT color="green">002</FONT> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a> |
| <FONT color="green">003</FONT> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a> |
| <FONT color="green">004</FONT> * distributed with this work for additional information<a name="line.4"></a> |
| <FONT color="green">005</FONT> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a> |
| <FONT color="green">006</FONT> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a> |
| <FONT color="green">007</FONT> * "License"); you may not use this file except in compliance<a name="line.7"></a> |
| <FONT color="green">008</FONT> * with the License. You may obtain a copy of the License at<a name="line.8"></a> |
| <FONT color="green">009</FONT> *<a name="line.9"></a> |
| <FONT color="green">010</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a> |
| <FONT color="green">011</FONT> *<a name="line.11"></a> |
| <FONT color="green">012</FONT> * Unless required by applicable law or agreed to in writing,<a name="line.12"></a> |
| <FONT color="green">013</FONT> * software distributed under the License is distributed on an<a name="line.13"></a> |
| <FONT color="green">014</FONT> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a> |
| <FONT color="green">015</FONT> * KIND, either express or implied. See the License for the<a name="line.15"></a> |
| <FONT color="green">016</FONT> * specific language governing permissions and limitations<a name="line.16"></a> |
| <FONT color="green">017</FONT> * under the License.<a name="line.17"></a> |
| <FONT color="green">018</FONT> */<a name="line.18"></a> |
| <FONT color="green">019</FONT> package org.apache.shiro.web.servlet;<a name="line.19"></a> |
| <FONT color="green">020</FONT> <a name="line.20"></a> |
| <FONT color="green">021</FONT> import org.apache.shiro.util.StringUtils;<a name="line.21"></a> |
| <FONT color="green">022</FONT> import org.slf4j.Logger;<a name="line.22"></a> |
| <FONT color="green">023</FONT> import org.slf4j.LoggerFactory;<a name="line.23"></a> |
| <FONT color="green">024</FONT> <a name="line.24"></a> |
| <FONT color="green">025</FONT> import javax.servlet.http.HttpServletRequest;<a name="line.25"></a> |
| <FONT color="green">026</FONT> import javax.servlet.http.HttpServletResponse;<a name="line.26"></a> |
| <FONT color="green">027</FONT> import java.text.DateFormat;<a name="line.27"></a> |
| <FONT color="green">028</FONT> import java.text.SimpleDateFormat;<a name="line.28"></a> |
| <FONT color="green">029</FONT> import java.util.Calendar;<a name="line.29"></a> |
| <FONT color="green">030</FONT> import java.util.Date;<a name="line.30"></a> |
| <FONT color="green">031</FONT> import java.util.Locale;<a name="line.31"></a> |
| <FONT color="green">032</FONT> import java.util.TimeZone;<a name="line.32"></a> |
| <FONT color="green">033</FONT> <a name="line.33"></a> |
| <FONT color="green">034</FONT> /**<a name="line.34"></a> |
| <FONT color="green">035</FONT> * Default {@link Cookie Cookie} implementation. 'HttpOnly' is supported out of the box, even on<a name="line.35"></a> |
| <FONT color="green">036</FONT> * Servlet {@code 2.4} and {@code 2.5} container implementations, using raw header writing logic and not<a name="line.36"></a> |
| <FONT color="green">037</FONT> * {@link javax.servlet.http.Cookie javax.servlet.http.Cookie} objects (which only has 'HttpOnly' support in Servlet<a name="line.37"></a> |
| <FONT color="green">038</FONT> * {@code 2.6} specifications and above).<a name="line.38"></a> |
| <FONT color="green">039</FONT> *<a name="line.39"></a> |
| <FONT color="green">040</FONT> * @since 1.0<a name="line.40"></a> |
| <FONT color="green">041</FONT> */<a name="line.41"></a> |
| <FONT color="green">042</FONT> public class SimpleCookie implements Cookie {<a name="line.42"></a> |
| <FONT color="green">043</FONT> <a name="line.43"></a> |
| <FONT color="green">044</FONT> /**<a name="line.44"></a> |
| <FONT color="green">045</FONT> * {@code -1}, indicating the cookie should expire when the browser closes.<a name="line.45"></a> |
| <FONT color="green">046</FONT> */<a name="line.46"></a> |
| <FONT color="green">047</FONT> public static final int DEFAULT_MAX_AGE = -1;<a name="line.47"></a> |
| <FONT color="green">048</FONT> <a name="line.48"></a> |
| <FONT color="green">049</FONT> /**<a name="line.49"></a> |
| <FONT color="green">050</FONT> * {@code -1} indicating that no version property should be set on the cookie.<a name="line.50"></a> |
| <FONT color="green">051</FONT> */<a name="line.51"></a> |
| <FONT color="green">052</FONT> public static final int DEFAULT_VERSION = -1;<a name="line.52"></a> |
| <FONT color="green">053</FONT> <a name="line.53"></a> |
| <FONT color="green">054</FONT> //These constants are protected on purpose so that the test case can use them<a name="line.54"></a> |
| <FONT color="green">055</FONT> protected static final String NAME_VALUE_DELIMITER = "=";<a name="line.55"></a> |
| <FONT color="green">056</FONT> protected static final String ATTRIBUTE_DELIMITER = "; ";<a name="line.56"></a> |
| <FONT color="green">057</FONT> protected static final long DAY_MILLIS = 86400000; //1 day = 86,400,000 milliseconds<a name="line.57"></a> |
| <FONT color="green">058</FONT> protected static final String GMT_TIME_ZONE_ID = "GMT";<a name="line.58"></a> |
| <FONT color="green">059</FONT> protected static final String COOKIE_DATE_FORMAT_STRING = "EEE, dd-MMM-yyyy HH:mm:ss z";<a name="line.59"></a> |
| <FONT color="green">060</FONT> <a name="line.60"></a> |
| <FONT color="green">061</FONT> protected static final String COOKIE_HEADER_NAME = "Set-Cookie";<a name="line.61"></a> |
| <FONT color="green">062</FONT> protected static final String PATH_ATTRIBUTE_NAME = "Path";<a name="line.62"></a> |
| <FONT color="green">063</FONT> protected static final String EXPIRES_ATTRIBUTE_NAME = "Expires";<a name="line.63"></a> |
| <FONT color="green">064</FONT> protected static final String MAXAGE_ATTRIBUTE_NAME = "Max-Age";<a name="line.64"></a> |
| <FONT color="green">065</FONT> protected static final String DOMAIN_ATTRIBUTE_NAME = "Domain";<a name="line.65"></a> |
| <FONT color="green">066</FONT> protected static final String VERSION_ATTRIBUTE_NAME = "Version";<a name="line.66"></a> |
| <FONT color="green">067</FONT> protected static final String COMMENT_ATTRIBUTE_NAME = "Comment";<a name="line.67"></a> |
| <FONT color="green">068</FONT> protected static final String SECURE_ATTRIBUTE_NAME = "Secure";<a name="line.68"></a> |
| <FONT color="green">069</FONT> protected static final String HTTP_ONLY_ATTRIBUTE_NAME = "HttpOnly";<a name="line.69"></a> |
| <FONT color="green">070</FONT> <a name="line.70"></a> |
| <FONT color="green">071</FONT> private static final transient Logger log = LoggerFactory.getLogger(SimpleCookie.class);<a name="line.71"></a> |
| <FONT color="green">072</FONT> <a name="line.72"></a> |
| <FONT color="green">073</FONT> private String name;<a name="line.73"></a> |
| <FONT color="green">074</FONT> private String value;<a name="line.74"></a> |
| <FONT color="green">075</FONT> private String comment;<a name="line.75"></a> |
| <FONT color="green">076</FONT> private String domain;<a name="line.76"></a> |
| <FONT color="green">077</FONT> private String path;<a name="line.77"></a> |
| <FONT color="green">078</FONT> private int maxAge;<a name="line.78"></a> |
| <FONT color="green">079</FONT> private int version;<a name="line.79"></a> |
| <FONT color="green">080</FONT> private boolean secure;<a name="line.80"></a> |
| <FONT color="green">081</FONT> private boolean httpOnly;<a name="line.81"></a> |
| <FONT color="green">082</FONT> <a name="line.82"></a> |
| <FONT color="green">083</FONT> public SimpleCookie() {<a name="line.83"></a> |
| <FONT color="green">084</FONT> this.maxAge = DEFAULT_MAX_AGE;<a name="line.84"></a> |
| <FONT color="green">085</FONT> this.version = DEFAULT_VERSION;<a name="line.85"></a> |
| <FONT color="green">086</FONT> this.httpOnly = true; //most of the cookies ever used by Shiro should be as secure as possible.<a name="line.86"></a> |
| <FONT color="green">087</FONT> }<a name="line.87"></a> |
| <FONT color="green">088</FONT> <a name="line.88"></a> |
| <FONT color="green">089</FONT> public SimpleCookie(String name) {<a name="line.89"></a> |
| <FONT color="green">090</FONT> this();<a name="line.90"></a> |
| <FONT color="green">091</FONT> this.name = name;<a name="line.91"></a> |
| <FONT color="green">092</FONT> }<a name="line.92"></a> |
| <FONT color="green">093</FONT> <a name="line.93"></a> |
| <FONT color="green">094</FONT> public SimpleCookie(Cookie cookie) {<a name="line.94"></a> |
| <FONT color="green">095</FONT> this.name = cookie.getName();<a name="line.95"></a> |
| <FONT color="green">096</FONT> this.value = cookie.getValue();<a name="line.96"></a> |
| <FONT color="green">097</FONT> this.comment = cookie.getComment();<a name="line.97"></a> |
| <FONT color="green">098</FONT> this.domain = cookie.getDomain();<a name="line.98"></a> |
| <FONT color="green">099</FONT> this.path = cookie.getPath();<a name="line.99"></a> |
| <FONT color="green">100</FONT> this.maxAge = Math.max(DEFAULT_MAX_AGE, cookie.getMaxAge());<a name="line.100"></a> |
| <FONT color="green">101</FONT> this.version = Math.max(DEFAULT_VERSION, cookie.getVersion());<a name="line.101"></a> |
| <FONT color="green">102</FONT> this.secure = cookie.isSecure();<a name="line.102"></a> |
| <FONT color="green">103</FONT> this.httpOnly = cookie.isHttpOnly();<a name="line.103"></a> |
| <FONT color="green">104</FONT> }<a name="line.104"></a> |
| <FONT color="green">105</FONT> <a name="line.105"></a> |
| <FONT color="green">106</FONT> public String getName() {<a name="line.106"></a> |
| <FONT color="green">107</FONT> return name;<a name="line.107"></a> |
| <FONT color="green">108</FONT> }<a name="line.108"></a> |
| <FONT color="green">109</FONT> <a name="line.109"></a> |
| <FONT color="green">110</FONT> public void setName(String name) {<a name="line.110"></a> |
| <FONT color="green">111</FONT> if (!StringUtils.hasText(name)) {<a name="line.111"></a> |
| <FONT color="green">112</FONT> throw new IllegalArgumentException("Name cannot be null/empty.");<a name="line.112"></a> |
| <FONT color="green">113</FONT> }<a name="line.113"></a> |
| <FONT color="green">114</FONT> this.name = name;<a name="line.114"></a> |
| <FONT color="green">115</FONT> }<a name="line.115"></a> |
| <FONT color="green">116</FONT> <a name="line.116"></a> |
| <FONT color="green">117</FONT> public String getValue() {<a name="line.117"></a> |
| <FONT color="green">118</FONT> return value;<a name="line.118"></a> |
| <FONT color="green">119</FONT> }<a name="line.119"></a> |
| <FONT color="green">120</FONT> <a name="line.120"></a> |
| <FONT color="green">121</FONT> public void setValue(String value) {<a name="line.121"></a> |
| <FONT color="green">122</FONT> this.value = value;<a name="line.122"></a> |
| <FONT color="green">123</FONT> }<a name="line.123"></a> |
| <FONT color="green">124</FONT> <a name="line.124"></a> |
| <FONT color="green">125</FONT> public String getComment() {<a name="line.125"></a> |
| <FONT color="green">126</FONT> return comment;<a name="line.126"></a> |
| <FONT color="green">127</FONT> }<a name="line.127"></a> |
| <FONT color="green">128</FONT> <a name="line.128"></a> |
| <FONT color="green">129</FONT> public void setComment(String comment) {<a name="line.129"></a> |
| <FONT color="green">130</FONT> this.comment = comment;<a name="line.130"></a> |
| <FONT color="green">131</FONT> }<a name="line.131"></a> |
| <FONT color="green">132</FONT> <a name="line.132"></a> |
| <FONT color="green">133</FONT> public String getDomain() {<a name="line.133"></a> |
| <FONT color="green">134</FONT> return domain;<a name="line.134"></a> |
| <FONT color="green">135</FONT> }<a name="line.135"></a> |
| <FONT color="green">136</FONT> <a name="line.136"></a> |
| <FONT color="green">137</FONT> public void setDomain(String domain) {<a name="line.137"></a> |
| <FONT color="green">138</FONT> this.domain = domain;<a name="line.138"></a> |
| <FONT color="green">139</FONT> }<a name="line.139"></a> |
| <FONT color="green">140</FONT> <a name="line.140"></a> |
| <FONT color="green">141</FONT> public String getPath() {<a name="line.141"></a> |
| <FONT color="green">142</FONT> return path;<a name="line.142"></a> |
| <FONT color="green">143</FONT> }<a name="line.143"></a> |
| <FONT color="green">144</FONT> <a name="line.144"></a> |
| <FONT color="green">145</FONT> public void setPath(String path) {<a name="line.145"></a> |
| <FONT color="green">146</FONT> this.path = path;<a name="line.146"></a> |
| <FONT color="green">147</FONT> }<a name="line.147"></a> |
| <FONT color="green">148</FONT> <a name="line.148"></a> |
| <FONT color="green">149</FONT> public int getMaxAge() {<a name="line.149"></a> |
| <FONT color="green">150</FONT> return maxAge;<a name="line.150"></a> |
| <FONT color="green">151</FONT> }<a name="line.151"></a> |
| <FONT color="green">152</FONT> <a name="line.152"></a> |
| <FONT color="green">153</FONT> public void setMaxAge(int maxAge) {<a name="line.153"></a> |
| <FONT color="green">154</FONT> this.maxAge = Math.max(DEFAULT_MAX_AGE, maxAge);<a name="line.154"></a> |
| <FONT color="green">155</FONT> }<a name="line.155"></a> |
| <FONT color="green">156</FONT> <a name="line.156"></a> |
| <FONT color="green">157</FONT> public int getVersion() {<a name="line.157"></a> |
| <FONT color="green">158</FONT> return version;<a name="line.158"></a> |
| <FONT color="green">159</FONT> }<a name="line.159"></a> |
| <FONT color="green">160</FONT> <a name="line.160"></a> |
| <FONT color="green">161</FONT> public void setVersion(int version) {<a name="line.161"></a> |
| <FONT color="green">162</FONT> this.version = Math.max(DEFAULT_VERSION, version);<a name="line.162"></a> |
| <FONT color="green">163</FONT> }<a name="line.163"></a> |
| <FONT color="green">164</FONT> <a name="line.164"></a> |
| <FONT color="green">165</FONT> public boolean isSecure() {<a name="line.165"></a> |
| <FONT color="green">166</FONT> return secure;<a name="line.166"></a> |
| <FONT color="green">167</FONT> }<a name="line.167"></a> |
| <FONT color="green">168</FONT> <a name="line.168"></a> |
| <FONT color="green">169</FONT> public void setSecure(boolean secure) {<a name="line.169"></a> |
| <FONT color="green">170</FONT> this.secure = secure;<a name="line.170"></a> |
| <FONT color="green">171</FONT> }<a name="line.171"></a> |
| <FONT color="green">172</FONT> <a name="line.172"></a> |
| <FONT color="green">173</FONT> public boolean isHttpOnly() {<a name="line.173"></a> |
| <FONT color="green">174</FONT> return httpOnly;<a name="line.174"></a> |
| <FONT color="green">175</FONT> }<a name="line.175"></a> |
| <FONT color="green">176</FONT> <a name="line.176"></a> |
| <FONT color="green">177</FONT> public void setHttpOnly(boolean httpOnly) {<a name="line.177"></a> |
| <FONT color="green">178</FONT> this.httpOnly = httpOnly;<a name="line.178"></a> |
| <FONT color="green">179</FONT> }<a name="line.179"></a> |
| <FONT color="green">180</FONT> <a name="line.180"></a> |
| <FONT color="green">181</FONT> /**<a name="line.181"></a> |
| <FONT color="green">182</FONT> * Returns the Cookie's calculated path setting. If the {@link javax.servlet.http.Cookie#getPath() path} is {@code null}, then the<a name="line.182"></a> |
| <FONT color="green">183</FONT> * {@code request}'s {@link javax.servlet.http.HttpServletRequest#getContextPath() context path}<a name="line.183"></a> |
| <FONT color="green">184</FONT> * will be returned. If getContextPath() is the empty string or null then the ROOT_PATH constant is returned.<a name="line.184"></a> |
| <FONT color="green">185</FONT> *<a name="line.185"></a> |
| <FONT color="green">186</FONT> * @param request the incoming HttpServletRequest<a name="line.186"></a> |
| <FONT color="green">187</FONT> * @return the path to be used as the path when the cookie is created or removed<a name="line.187"></a> |
| <FONT color="green">188</FONT> */<a name="line.188"></a> |
| <FONT color="green">189</FONT> private String calculatePath(HttpServletRequest request) {<a name="line.189"></a> |
| <FONT color="green">190</FONT> String path = StringUtils.clean(getPath());<a name="line.190"></a> |
| <FONT color="green">191</FONT> if (!StringUtils.hasText(path)) {<a name="line.191"></a> |
| <FONT color="green">192</FONT> path = StringUtils.clean(request.getContextPath());<a name="line.192"></a> |
| <FONT color="green">193</FONT> }<a name="line.193"></a> |
| <FONT color="green">194</FONT> <a name="line.194"></a> |
| <FONT color="green">195</FONT> //fix for http://issues.apache.org/jira/browse/SHIRO-9:<a name="line.195"></a> |
| <FONT color="green">196</FONT> if (path == null) {<a name="line.196"></a> |
| <FONT color="green">197</FONT> path = ROOT_PATH;<a name="line.197"></a> |
| <FONT color="green">198</FONT> }<a name="line.198"></a> |
| <FONT color="green">199</FONT> log.trace("calculated path: {}", path);<a name="line.199"></a> |
| <FONT color="green">200</FONT> return path;<a name="line.200"></a> |
| <FONT color="green">201</FONT> }<a name="line.201"></a> |
| <FONT color="green">202</FONT> <a name="line.202"></a> |
| <FONT color="green">203</FONT> public void saveTo(HttpServletRequest request, HttpServletResponse response) {<a name="line.203"></a> |
| <FONT color="green">204</FONT> <a name="line.204"></a> |
| <FONT color="green">205</FONT> String name = getName();<a name="line.205"></a> |
| <FONT color="green">206</FONT> String value = getValue();<a name="line.206"></a> |
| <FONT color="green">207</FONT> String comment = getComment();<a name="line.207"></a> |
| <FONT color="green">208</FONT> String domain = getDomain();<a name="line.208"></a> |
| <FONT color="green">209</FONT> String path = calculatePath(request);<a name="line.209"></a> |
| <FONT color="green">210</FONT> int maxAge = getMaxAge();<a name="line.210"></a> |
| <FONT color="green">211</FONT> int version = getVersion();<a name="line.211"></a> |
| <FONT color="green">212</FONT> boolean secure = isSecure();<a name="line.212"></a> |
| <FONT color="green">213</FONT> boolean httpOnly = isHttpOnly();<a name="line.213"></a> |
| <FONT color="green">214</FONT> <a name="line.214"></a> |
| <FONT color="green">215</FONT> addCookieHeader(response, name, value, comment, domain, path, maxAge, version, secure, httpOnly);<a name="line.215"></a> |
| <FONT color="green">216</FONT> }<a name="line.216"></a> |
| <FONT color="green">217</FONT> <a name="line.217"></a> |
| <FONT color="green">218</FONT> private void addCookieHeader(HttpServletResponse response, String name, String value, String comment,<a name="line.218"></a> |
| <FONT color="green">219</FONT> String domain, String path, int maxAge, int version,<a name="line.219"></a> |
| <FONT color="green">220</FONT> boolean secure, boolean httpOnly) {<a name="line.220"></a> |
| <FONT color="green">221</FONT> <a name="line.221"></a> |
| <FONT color="green">222</FONT> String headerValue = buildHeaderValue(name, value, comment, domain, path, maxAge, version, secure, httpOnly);<a name="line.222"></a> |
| <FONT color="green">223</FONT> response.addHeader(COOKIE_HEADER_NAME, headerValue);<a name="line.223"></a> |
| <FONT color="green">224</FONT> <a name="line.224"></a> |
| <FONT color="green">225</FONT> if (log.isDebugEnabled()) {<a name="line.225"></a> |
| <FONT color="green">226</FONT> log.debug("Added HttpServletResponse Cookie [{}]", headerValue);<a name="line.226"></a> |
| <FONT color="green">227</FONT> }<a name="line.227"></a> |
| <FONT color="green">228</FONT> }<a name="line.228"></a> |
| <FONT color="green">229</FONT> <a name="line.229"></a> |
| <FONT color="green">230</FONT> /*<a name="line.230"></a> |
| <FONT color="green">231</FONT> * This implementation followed the grammar defined here for convenience:<a name="line.231"></a> |
| <FONT color="green">232</FONT> * <a href="http://github.com/abarth/http-state/blob/master/notes/2009-11-07-Yui-Naruse.txt">Cookie grammar</a>.<a name="line.232"></a> |
| <FONT color="green">233</FONT> *<a name="line.233"></a> |
| <FONT color="green">234</FONT> * @return the 'Set-Cookie' header value for this cookie instance.<a name="line.234"></a> |
| <FONT color="green">235</FONT> */<a name="line.235"></a> |
| <FONT color="green">236</FONT> <a name="line.236"></a> |
| <FONT color="green">237</FONT> protected String buildHeaderValue(String name, String value, String comment,<a name="line.237"></a> |
| <FONT color="green">238</FONT> String domain, String path, int maxAge, int version,<a name="line.238"></a> |
| <FONT color="green">239</FONT> boolean secure, boolean httpOnly) {<a name="line.239"></a> |
| <FONT color="green">240</FONT> <a name="line.240"></a> |
| <FONT color="green">241</FONT> if (!StringUtils.hasText(name)) {<a name="line.241"></a> |
| <FONT color="green">242</FONT> throw new IllegalStateException("Cookie name cannot be null/empty.");<a name="line.242"></a> |
| <FONT color="green">243</FONT> }<a name="line.243"></a> |
| <FONT color="green">244</FONT> <a name="line.244"></a> |
| <FONT color="green">245</FONT> StringBuilder sb = new StringBuilder(name).append(NAME_VALUE_DELIMITER);<a name="line.245"></a> |
| <FONT color="green">246</FONT> <a name="line.246"></a> |
| <FONT color="green">247</FONT> if (StringUtils.hasText(value)) {<a name="line.247"></a> |
| <FONT color="green">248</FONT> sb.append(value);<a name="line.248"></a> |
| <FONT color="green">249</FONT> }<a name="line.249"></a> |
| <FONT color="green">250</FONT> <a name="line.250"></a> |
| <FONT color="green">251</FONT> appendComment(sb, comment);<a name="line.251"></a> |
| <FONT color="green">252</FONT> appendDomain(sb, domain);<a name="line.252"></a> |
| <FONT color="green">253</FONT> appendPath(sb, path);<a name="line.253"></a> |
| <FONT color="green">254</FONT> appendExpires(sb, maxAge);<a name="line.254"></a> |
| <FONT color="green">255</FONT> appendVersion(sb, version);<a name="line.255"></a> |
| <FONT color="green">256</FONT> appendSecure(sb, secure);<a name="line.256"></a> |
| <FONT color="green">257</FONT> appendHttpOnly(sb, httpOnly);<a name="line.257"></a> |
| <FONT color="green">258</FONT> <a name="line.258"></a> |
| <FONT color="green">259</FONT> return sb.toString();<a name="line.259"></a> |
| <FONT color="green">260</FONT> <a name="line.260"></a> |
| <FONT color="green">261</FONT> }<a name="line.261"></a> |
| <FONT color="green">262</FONT> <a name="line.262"></a> |
| <FONT color="green">263</FONT> private void appendComment(StringBuilder sb, String comment) {<a name="line.263"></a> |
| <FONT color="green">264</FONT> if (StringUtils.hasText(comment)) {<a name="line.264"></a> |
| <FONT color="green">265</FONT> sb.append(ATTRIBUTE_DELIMITER);<a name="line.265"></a> |
| <FONT color="green">266</FONT> sb.append(COMMENT_ATTRIBUTE_NAME).append(NAME_VALUE_DELIMITER).append(comment);<a name="line.266"></a> |
| <FONT color="green">267</FONT> }<a name="line.267"></a> |
| <FONT color="green">268</FONT> }<a name="line.268"></a> |
| <FONT color="green">269</FONT> <a name="line.269"></a> |
| <FONT color="green">270</FONT> private void appendDomain(StringBuilder sb, String domain) {<a name="line.270"></a> |
| <FONT color="green">271</FONT> if (StringUtils.hasText(domain)) {<a name="line.271"></a> |
| <FONT color="green">272</FONT> sb.append(ATTRIBUTE_DELIMITER);<a name="line.272"></a> |
| <FONT color="green">273</FONT> sb.append(DOMAIN_ATTRIBUTE_NAME).append(NAME_VALUE_DELIMITER).append(domain);<a name="line.273"></a> |
| <FONT color="green">274</FONT> }<a name="line.274"></a> |
| <FONT color="green">275</FONT> }<a name="line.275"></a> |
| <FONT color="green">276</FONT> <a name="line.276"></a> |
| <FONT color="green">277</FONT> private void appendPath(StringBuilder sb, String path) {<a name="line.277"></a> |
| <FONT color="green">278</FONT> if (StringUtils.hasText(path)) {<a name="line.278"></a> |
| <FONT color="green">279</FONT> sb.append(ATTRIBUTE_DELIMITER);<a name="line.279"></a> |
| <FONT color="green">280</FONT> sb.append(PATH_ATTRIBUTE_NAME).append(NAME_VALUE_DELIMITER).append(path);<a name="line.280"></a> |
| <FONT color="green">281</FONT> }<a name="line.281"></a> |
| <FONT color="green">282</FONT> }<a name="line.282"></a> |
| <FONT color="green">283</FONT> <a name="line.283"></a> |
| <FONT color="green">284</FONT> private void appendExpires(StringBuilder sb, int maxAge) {<a name="line.284"></a> |
| <FONT color="green">285</FONT> // if maxAge is negative, cookie should should expire when browser closes<a name="line.285"></a> |
| <FONT color="green">286</FONT> // Don't write the maxAge cookie value if it's negative - at least on Firefox it'll cause the <a name="line.286"></a> |
| <FONT color="green">287</FONT> // cookie to be deleted immediately<a name="line.287"></a> |
| <FONT color="green">288</FONT> // Write the expires header used by older browsers, but may be unnecessary<a name="line.288"></a> |
| <FONT color="green">289</FONT> // and it is not by the spec, see http://www.faqs.org/rfcs/rfc2965.html<a name="line.289"></a> |
| <FONT color="green">290</FONT> // TODO consider completely removing the following <a name="line.290"></a> |
| <FONT color="green">291</FONT> if (maxAge >= 0) {<a name="line.291"></a> |
| <FONT color="green">292</FONT> sb.append(ATTRIBUTE_DELIMITER);<a name="line.292"></a> |
| <FONT color="green">293</FONT> sb.append(MAXAGE_ATTRIBUTE_NAME).append(NAME_VALUE_DELIMITER).append(maxAge);<a name="line.293"></a> |
| <FONT color="green">294</FONT> sb.append(ATTRIBUTE_DELIMITER);<a name="line.294"></a> |
| <FONT color="green">295</FONT> Date expires;<a name="line.295"></a> |
| <FONT color="green">296</FONT> if (maxAge == 0) {<a name="line.296"></a> |
| <FONT color="green">297</FONT> //delete the cookie by specifying a time in the past (1 day ago):<a name="line.297"></a> |
| <FONT color="green">298</FONT> expires = new Date(System.currentTimeMillis() - DAY_MILLIS);<a name="line.298"></a> |
| <FONT color="green">299</FONT> } else {<a name="line.299"></a> |
| <FONT color="green">300</FONT> //Value is in seconds. So take 'now' and add that many seconds, and that's our expiration date:<a name="line.300"></a> |
| <FONT color="green">301</FONT> Calendar cal = Calendar.getInstance();<a name="line.301"></a> |
| <FONT color="green">302</FONT> cal.add(Calendar.SECOND, maxAge);<a name="line.302"></a> |
| <FONT color="green">303</FONT> expires = cal.getTime();<a name="line.303"></a> |
| <FONT color="green">304</FONT> }<a name="line.304"></a> |
| <FONT color="green">305</FONT> String formatted = toCookieDate(expires);<a name="line.305"></a> |
| <FONT color="green">306</FONT> sb.append(EXPIRES_ATTRIBUTE_NAME).append(NAME_VALUE_DELIMITER).append(formatted);<a name="line.306"></a> |
| <FONT color="green">307</FONT> }<a name="line.307"></a> |
| <FONT color="green">308</FONT> }<a name="line.308"></a> |
| <FONT color="green">309</FONT> <a name="line.309"></a> |
| <FONT color="green">310</FONT> private void appendVersion(StringBuilder sb, int version) {<a name="line.310"></a> |
| <FONT color="green">311</FONT> if (version > DEFAULT_VERSION) {<a name="line.311"></a> |
| <FONT color="green">312</FONT> sb.append(ATTRIBUTE_DELIMITER);<a name="line.312"></a> |
| <FONT color="green">313</FONT> sb.append(VERSION_ATTRIBUTE_NAME).append(NAME_VALUE_DELIMITER).append(version);<a name="line.313"></a> |
| <FONT color="green">314</FONT> }<a name="line.314"></a> |
| <FONT color="green">315</FONT> }<a name="line.315"></a> |
| <FONT color="green">316</FONT> <a name="line.316"></a> |
| <FONT color="green">317</FONT> private void appendSecure(StringBuilder sb, boolean secure) {<a name="line.317"></a> |
| <FONT color="green">318</FONT> if (secure) {<a name="line.318"></a> |
| <FONT color="green">319</FONT> sb.append(ATTRIBUTE_DELIMITER);<a name="line.319"></a> |
| <FONT color="green">320</FONT> sb.append(SECURE_ATTRIBUTE_NAME); //No value for this attribute<a name="line.320"></a> |
| <FONT color="green">321</FONT> }<a name="line.321"></a> |
| <FONT color="green">322</FONT> }<a name="line.322"></a> |
| <FONT color="green">323</FONT> <a name="line.323"></a> |
| <FONT color="green">324</FONT> private void appendHttpOnly(StringBuilder sb, boolean httpOnly) {<a name="line.324"></a> |
| <FONT color="green">325</FONT> if (httpOnly) {<a name="line.325"></a> |
| <FONT color="green">326</FONT> sb.append(ATTRIBUTE_DELIMITER);<a name="line.326"></a> |
| <FONT color="green">327</FONT> sb.append(HTTP_ONLY_ATTRIBUTE_NAME); //No value for this attribute<a name="line.327"></a> |
| <FONT color="green">328</FONT> }<a name="line.328"></a> |
| <FONT color="green">329</FONT> }<a name="line.329"></a> |
| <FONT color="green">330</FONT> <a name="line.330"></a> |
| <FONT color="green">331</FONT> /**<a name="line.331"></a> |
| <FONT color="green">332</FONT> * Formats a date into a cookie date compatible string (Netscape's specification).<a name="line.332"></a> |
| <FONT color="green">333</FONT> *<a name="line.333"></a> |
| <FONT color="green">334</FONT> * @param date the date to format<a name="line.334"></a> |
| <FONT color="green">335</FONT> * @return an HTTP 1.0/1.1 Cookie compatible date string (GMT-based).<a name="line.335"></a> |
| <FONT color="green">336</FONT> */<a name="line.336"></a> |
| <FONT color="green">337</FONT> private static String toCookieDate(Date date) {<a name="line.337"></a> |
| <FONT color="green">338</FONT> TimeZone tz = TimeZone.getTimeZone(GMT_TIME_ZONE_ID);<a name="line.338"></a> |
| <FONT color="green">339</FONT> DateFormat fmt = new SimpleDateFormat(COOKIE_DATE_FORMAT_STRING, Locale.US);<a name="line.339"></a> |
| <FONT color="green">340</FONT> fmt.setTimeZone(tz);<a name="line.340"></a> |
| <FONT color="green">341</FONT> return fmt.format(date);<a name="line.341"></a> |
| <FONT color="green">342</FONT> }<a name="line.342"></a> |
| <FONT color="green">343</FONT> <a name="line.343"></a> |
| <FONT color="green">344</FONT> public void removeFrom(HttpServletRequest request, HttpServletResponse response) {<a name="line.344"></a> |
| <FONT color="green">345</FONT> String name = getName();<a name="line.345"></a> |
| <FONT color="green">346</FONT> String value = DELETED_COOKIE_VALUE;<a name="line.346"></a> |
| <FONT color="green">347</FONT> String comment = null; //don't need to add extra size to the response - comments are irrelevant for deletions<a name="line.347"></a> |
| <FONT color="green">348</FONT> String domain = getDomain();<a name="line.348"></a> |
| <FONT color="green">349</FONT> String path = calculatePath(request);<a name="line.349"></a> |
| <FONT color="green">350</FONT> int maxAge = 0; //always zero for deletion<a name="line.350"></a> |
| <FONT color="green">351</FONT> int version = getVersion();<a name="line.351"></a> |
| <FONT color="green">352</FONT> boolean secure = isSecure();<a name="line.352"></a> |
| <FONT color="green">353</FONT> boolean httpOnly = false; //no need to add the extra text, plus the value 'deleteMe' is not sensitive at all<a name="line.353"></a> |
| <FONT color="green">354</FONT> <a name="line.354"></a> |
| <FONT color="green">355</FONT> addCookieHeader(response, name, value, comment, domain, path, maxAge, version, secure, httpOnly);<a name="line.355"></a> |
| <FONT color="green">356</FONT> <a name="line.356"></a> |
| <FONT color="green">357</FONT> log.trace("Removed '{}' cookie by setting maxAge=0", name);<a name="line.357"></a> |
| <FONT color="green">358</FONT> }<a name="line.358"></a> |
| <FONT color="green">359</FONT> <a name="line.359"></a> |
| <FONT color="green">360</FONT> public String readValue(HttpServletRequest request, HttpServletResponse ignored) {<a name="line.360"></a> |
| <FONT color="green">361</FONT> String name = getName();<a name="line.361"></a> |
| <FONT color="green">362</FONT> String value = null;<a name="line.362"></a> |
| <FONT color="green">363</FONT> javax.servlet.http.Cookie cookie = getCookie(request, name);<a name="line.363"></a> |
| <FONT color="green">364</FONT> if (cookie != null) {<a name="line.364"></a> |
| <FONT color="green">365</FONT> value = cookie.getValue();<a name="line.365"></a> |
| <FONT color="green">366</FONT> log.debug("Found '{}' cookie value [{}]", name, value);<a name="line.366"></a> |
| <FONT color="green">367</FONT> } else {<a name="line.367"></a> |
| <FONT color="green">368</FONT> log.trace("No '{}' cookie value", name);<a name="line.368"></a> |
| <FONT color="green">369</FONT> }<a name="line.369"></a> |
| <FONT color="green">370</FONT> <a name="line.370"></a> |
| <FONT color="green">371</FONT> return value;<a name="line.371"></a> |
| <FONT color="green">372</FONT> }<a name="line.372"></a> |
| <FONT color="green">373</FONT> <a name="line.373"></a> |
| <FONT color="green">374</FONT> /**<a name="line.374"></a> |
| <FONT color="green">375</FONT> * Returns the cookie with the given name from the request or {@code null} if no cookie<a name="line.375"></a> |
| <FONT color="green">376</FONT> * with that name could be found.<a name="line.376"></a> |
| <FONT color="green">377</FONT> *<a name="line.377"></a> |
| <FONT color="green">378</FONT> * @param request the current executing http request.<a name="line.378"></a> |
| <FONT color="green">379</FONT> * @param cookieName the name of the cookie to find and return.<a name="line.379"></a> |
| <FONT color="green">380</FONT> * @return the cookie with the given name from the request or {@code null} if no cookie<a name="line.380"></a> |
| <FONT color="green">381</FONT> * with that name could be found.<a name="line.381"></a> |
| <FONT color="green">382</FONT> */<a name="line.382"></a> |
| <FONT color="green">383</FONT> private static javax.servlet.http.Cookie getCookie(HttpServletRequest request, String cookieName) {<a name="line.383"></a> |
| <FONT color="green">384</FONT> javax.servlet.http.Cookie cookies[] = request.getCookies();<a name="line.384"></a> |
| <FONT color="green">385</FONT> if (cookies != null) {<a name="line.385"></a> |
| <FONT color="green">386</FONT> for (javax.servlet.http.Cookie cookie : cookies) {<a name="line.386"></a> |
| <FONT color="green">387</FONT> if (cookie.getName().equals(cookieName)) {<a name="line.387"></a> |
| <FONT color="green">388</FONT> return cookie;<a name="line.388"></a> |
| <FONT color="green">389</FONT> }<a name="line.389"></a> |
| <FONT color="green">390</FONT> }<a name="line.390"></a> |
| <FONT color="green">391</FONT> }<a name="line.391"></a> |
| <FONT color="green">392</FONT> return null;<a name="line.392"></a> |
| <FONT color="green">393</FONT> }<a name="line.393"></a> |
| <FONT color="green">394</FONT> }<a name="line.394"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </PRE> |
| </BODY> |
| </HTML> |
