1
2
3
4
5
6
7
8
9
10
11
12
13
14
15 package org.htmlunit.httpclient;
16
17 import java.util.ArrayList;
18 import java.util.BitSet;
19 import java.util.Calendar;
20 import java.util.Collections;
21 import java.util.Comparator;
22 import java.util.Date;
23 import java.util.List;
24 import java.util.Locale;
25
26 import org.apache.http.FormattedHeader;
27 import org.apache.http.Header;
28 import org.apache.http.HeaderElement;
29 import org.apache.http.NameValuePair;
30 import org.apache.http.ParseException;
31 import org.apache.http.client.utils.DateUtils;
32 import org.apache.http.cookie.Cookie;
33 import org.apache.http.cookie.CookieAttributeHandler;
34 import org.apache.http.cookie.CookieOrigin;
35 import org.apache.http.cookie.CookiePathComparator;
36 import org.apache.http.cookie.MalformedCookieException;
37 import org.apache.http.cookie.SM;
38 import org.apache.http.impl.cookie.BasicClientCookie;
39 import org.apache.http.impl.cookie.BasicCommentHandler;
40 import org.apache.http.impl.cookie.CookieSpecBase;
41 import org.apache.http.message.BasicHeader;
42 import org.apache.http.message.BasicHeaderElement;
43 import org.apache.http.message.BasicNameValuePair;
44 import org.apache.http.message.BufferedHeader;
45 import org.apache.http.message.ParserCursor;
46 import org.apache.http.message.TokenParser;
47 import org.apache.http.util.CharArrayBuffer;
48 import org.htmlunit.BrowserVersion;
49 import org.htmlunit.util.StringUtils;
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69 public class HtmlUnitBrowserCompatCookieSpec extends CookieSpecBase {
70
71
72 public static final String EMPTY_COOKIE_NAME = "HTMLUNIT_EMPTY_COOKIE";
73
74
75 public static final String LOCAL_FILESYSTEM_DOMAIN = "LOCAL_FILESYSTEM";
76
77
78
79
80
81
82
83 private static final Comparator<Cookie> COOKIE_COMPARATOR = new CookiePathComparator();
84
85 private static final NetscapeDraftHeaderParser DEFAULT_NETSCAPE_DRAFT_HEADER_PARSER
86 = new NetscapeDraftHeaderParser();
87
88 static final Date DATE_1_1_1970;
89
90 static {
91 final Calendar calendar = Calendar.getInstance(Locale.ROOT);
92 calendar.setTimeZone(DateUtils.GMT);
93 calendar.set(1970, Calendar.JANUARY, 1, 0, 0, 0);
94 calendar.set(Calendar.MILLISECOND, 0);
95 DATE_1_1_1970 = calendar.getTime();
96 }
97
98
99
100
101
102
103 public HtmlUnitBrowserCompatCookieSpec(final BrowserVersion browserVersion) {
104 super(new HtmlUnitVersionAttributeHandler(),
105 new HtmlUnitDomainHandler(browserVersion),
106 new HtmlUnitPathHandler(),
107 new HtmlUnitMaxAgeHandler(),
108 new HtmlUnitSecureHandler(),
109 new BasicCommentHandler(),
110 new HtmlUnitExpiresHandler(browserVersion),
111 new HtmlUnitHttpOnlyHandler(),
112 new HtmlUnitSameSiteHandler());
113 }
114
115
116
117
118 @Override
119 public List<Cookie> parse(Header header, final CookieOrigin origin) throws MalformedCookieException {
120
121 final String text = header.getValue();
122 int endPos = text.indexOf(';');
123 if (endPos < 0) {
124 endPos = text.indexOf('=');
125 }
126 else {
127 final int pos = text.indexOf('=');
128 if (pos > endPos) {
129 endPos = -1;
130 }
131 else {
132 endPos = pos;
133 }
134 }
135 if (endPos < 0) {
136 header = new BasicHeader(header.getName(), EMPTY_COOKIE_NAME + "=" + header.getValue());
137 }
138 else if (endPos == 0 || StringUtils.isBlank(text.substring(0, endPos))) {
139 header = new BasicHeader(header.getName(), EMPTY_COOKIE_NAME + header.getValue());
140 }
141
142 final String headername = header.getName();
143 if (!SM.SET_COOKIE.equalsIgnoreCase(headername)) {
144 throw new MalformedCookieException("Unrecognized cookie header '" + header + "'");
145 }
146 final HeaderElement[] helems = header.getElements();
147 boolean versioned = false;
148 boolean netscape = false;
149 for (final HeaderElement helem: helems) {
150 if (helem.getParameterByName("version") != null) {
151 versioned = true;
152 }
153 if (helem.getParameterByName("expires") != null) {
154 netscape = true;
155 }
156 }
157
158 final List<Cookie> cookies;
159 if (netscape || !versioned) {
160
161
162 final CharArrayBuffer buffer;
163 final ParserCursor cursor;
164 if (header instanceof FormattedHeader) {
165 buffer = ((FormattedHeader) header).getBuffer();
166 cursor = new ParserCursor(
167 ((FormattedHeader) header).getValuePos(),
168 buffer.length());
169 }
170 else {
171 final String s = header.getValue();
172 if (s == null) {
173 throw new MalformedCookieException("Header value is null");
174 }
175 buffer = new CharArrayBuffer(s.length());
176 buffer.append(s);
177 cursor = new ParserCursor(0, buffer.length());
178 }
179 final HeaderElement elem = DEFAULT_NETSCAPE_DRAFT_HEADER_PARSER.parseHeader(buffer, cursor);
180 final String name = elem.getName();
181 if (name == null || name.isEmpty()) {
182 throw new MalformedCookieException("Cookie name may not be empty");
183 }
184 final String value = elem.getValue();
185 final BasicClientCookie cookie = new BasicClientCookie(name, value);
186 cookie.setPath(getDefaultPath(origin));
187 cookie.setDomain(getDefaultDomain(origin));
188
189
190 final NameValuePair[] attribs = elem.getParameters();
191 for (int j = attribs.length - 1; j >= 0; j--) {
192 final NameValuePair attrib = attribs[j];
193 final String s = attrib.getName().toLowerCase(Locale.ROOT);
194 cookie.setAttribute(s, attrib.getValue());
195 final CookieAttributeHandler handler = findAttribHandler(s);
196 if (handler != null) {
197 handler.parse(cookie, attrib.getValue());
198 }
199 }
200
201 if (netscape) {
202 cookie.setVersion(0);
203 }
204 cookies = Collections.singletonList(cookie);
205 }
206 else {
207 cookies = parse(helems, origin);
208 }
209
210 for (final Cookie c : cookies) {
211
212 if (header.getValue().contains(c.getName() + "=\"" + c.getValue())) {
213 ((BasicClientCookie) c).setValue('"' + c.getValue() + '"');
214 }
215 }
216 return cookies;
217 }
218
219 @Override
220 public List<Header> formatCookies(final List<Cookie> cookies) {
221 cookies.sort(COOKIE_COMPARATOR);
222
223 final CharArrayBuffer buffer = new CharArrayBuffer(20 * cookies.size());
224 buffer.append(SM.COOKIE);
225 buffer.append(": ");
226 final int size = cookies.size();
227 for (int i = 0; i < size; i++) {
228 final Cookie cookie = cookies.get(i);
229 if (i > 0) {
230 buffer.append("; ");
231 }
232 final String cookieName = cookie.getName();
233 final String cookieValue = cookie.getValue();
234 if (cookie.getVersion() > 0 && !isQuoteEnclosed(cookieValue)) {
235 HtmlUnitBrowserCompatCookieHeaderValueFormatter.INSTANCE.formatHeaderElement(
236 buffer,
237 new BasicHeaderElement(cookieName, cookieValue),
238 false);
239 }
240 else {
241
242 buffer.append(cookieName);
243 buffer.append("=");
244 if (cookieValue != null) {
245 buffer.append(cookieValue);
246 }
247 }
248 }
249 final List<Header> headers = new ArrayList<>(1);
250 headers.add(new BufferedHeader(buffer));
251 return headers;
252 }
253
254 private static boolean isQuoteEnclosed(final String s) {
255 return s != null
256 && s.length() > 1
257 && '\"' == s.charAt(0)
258 && '\"' == s.charAt(s.length() - 1);
259 }
260
261 @Override
262 public int getVersion() {
263 return 0;
264 }
265
266 @Override
267 public Header getVersionHeader() {
268 return null;
269 }
270
271 @Override
272 public String toString() {
273 return "compatibility";
274 }
275
276 private static final class NetscapeDraftHeaderParser {
277
278 private static final char PARAM_DELIMITER = ';';
279
280
281
282 private static final BitSet TOKEN_DELIMS = TokenParser.INIT_BITSET('=', PARAM_DELIMITER);
283 private static final BitSet VALUE_DELIMS = TokenParser.INIT_BITSET(PARAM_DELIMITER);
284
285 private static final TokenParser TOKEN_PARSER = TokenParser.INSTANCE;
286
287 HeaderElement parseHeader(final CharArrayBuffer buffer, final ParserCursor cursor) throws ParseException {
288 final NameValuePair nvp = parseNameValuePair(buffer, cursor);
289 final List<NameValuePair> params = new ArrayList<>();
290 while (!cursor.atEnd()) {
291 final NameValuePair param = parseNameValuePair(buffer, cursor);
292 params.add(param);
293 }
294
295 return new BasicHeaderElement(nvp.getName(), nvp.getValue(),
296 params.toArray(new NameValuePair[0]));
297 }
298
299 private NameValuePair parseNameValuePair(final CharArrayBuffer buffer, final ParserCursor cursor) {
300 final String name = TOKEN_PARSER.parseToken(buffer, cursor, TOKEN_DELIMS);
301 if (cursor.atEnd()) {
302 return new BasicNameValuePair(name, null);
303 }
304
305 final int delim = buffer.charAt(cursor.getPos());
306 cursor.updatePos(cursor.getPos() + 1);
307 if (delim != '=') {
308 return new BasicNameValuePair(name, null);
309 }
310
311 final String value = TOKEN_PARSER.parseToken(buffer, cursor, VALUE_DELIMS);
312 if (!cursor.atEnd()) {
313 cursor.updatePos(cursor.getPos() + 1);
314 }
315
316 return new BasicNameValuePair(name, value);
317 }
318 }
319 }