1 /*
2  * ====================================================================
3  * Licensed to the Apache Software Foundation (ASF) under one
4  * or more contributor license agreements.  See the NOTICE file
5  * distributed with this work for additional information
6  * regarding copyright ownership.  The ASF licenses this file
7  * to you under the Apache License, Version 2.0 (the
8  * "License"); you may not use this file except in compliance
9  * with the License.  You may obtain a copy of the License at
10  *
11  *   http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing,
14  * software distributed under the License is distributed on an
15  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16  * KIND, either express or implied.  See the License for the
17  * specific language governing permissions and limitations
18  * under the License.
19  * ====================================================================
20  *
21  * This software consists of voluntary contributions made by many
22  * individuals on behalf of the Apache Software Foundation.  For more
23  * information on the Apache Software Foundation, please see
24  * <http://www.apache.org/>.
25  *
26  */
27 
28 package ch.boye.httpclientandroidlib.impl.cookie;
29 
30 import java.util.ArrayList;
31 import java.util.List;
32 import java.util.Locale;
33 
34 import ch.boye.httpclientandroidlib.HeaderElement;
35 import ch.boye.httpclientandroidlib.NameValuePair;
36 import ch.boye.httpclientandroidlib.annotation.NotThreadSafe;
37 import ch.boye.httpclientandroidlib.cookie.Cookie;
38 import ch.boye.httpclientandroidlib.cookie.CookieAttributeHandler;
39 import ch.boye.httpclientandroidlib.cookie.CookieOrigin;
40 import ch.boye.httpclientandroidlib.cookie.MalformedCookieException;
41 import ch.boye.httpclientandroidlib.util.Args;
42 
43 /**
44  * Cookie management functions shared by all specification.
45  *
46  *
47  * @since 4.0
48  */
49 @NotThreadSafe // AbstractCookieSpec is not thread-safe
50 public abstract class CookieSpecBase extends AbstractCookieSpec {
51 
getDefaultPath(final CookieOrigin origin)52     protected static String getDefaultPath(final CookieOrigin origin) {
53         String defaultPath = origin.getPath();
54         int lastSlashIndex = defaultPath.lastIndexOf('/');
55         if (lastSlashIndex >= 0) {
56             if (lastSlashIndex == 0) {
57                 //Do not remove the very first slash
58                 lastSlashIndex = 1;
59             }
60             defaultPath = defaultPath.substring(0, lastSlashIndex);
61         }
62         return defaultPath;
63     }
64 
getDefaultDomain(final CookieOrigin origin)65     protected static String getDefaultDomain(final CookieOrigin origin) {
66         return origin.getHost();
67     }
68 
parse(final HeaderElement[] elems, final CookieOrigin origin)69     protected List<Cookie> parse(final HeaderElement[] elems, final CookieOrigin origin)
70                 throws MalformedCookieException {
71         final List<Cookie> cookies = new ArrayList<Cookie>(elems.length);
72         for (final HeaderElement headerelement : elems) {
73             final String name = headerelement.getName();
74             final String value = headerelement.getValue();
75             if (name == null || name.length() == 0) {
76                 throw new MalformedCookieException("Cookie name may not be empty");
77             }
78 
79             final BasicClientCookie cookie = new BasicClientCookie(name, value);
80             cookie.setPath(getDefaultPath(origin));
81             cookie.setDomain(getDefaultDomain(origin));
82 
83             // cycle through the parameters
84             final NameValuePair[] attribs = headerelement.getParameters();
85             for (int j = attribs.length - 1; j >= 0; j--) {
86                 final NameValuePair attrib = attribs[j];
87                 final String s = attrib.getName().toLowerCase(Locale.ENGLISH);
88 
89                 cookie.setAttribute(s, attrib.getValue());
90 
91                 final CookieAttributeHandler handler = findAttribHandler(s);
92                 if (handler != null) {
93                     handler.parse(cookie, attrib.getValue());
94                 }
95             }
96             cookies.add(cookie);
97         }
98         return cookies;
99     }
100 
validate(final Cookie cookie, final CookieOrigin origin)101     public void validate(final Cookie cookie, final CookieOrigin origin)
102             throws MalformedCookieException {
103         Args.notNull(cookie, "Cookie");
104         Args.notNull(origin, "Cookie origin");
105         for (final CookieAttributeHandler handler: getAttribHandlers()) {
106             handler.validate(cookie, origin);
107         }
108     }
109 
match(final Cookie cookie, final CookieOrigin origin)110     public boolean match(final Cookie cookie, final CookieOrigin origin) {
111         Args.notNull(cookie, "Cookie");
112         Args.notNull(origin, "Cookie origin");
113         for (final CookieAttributeHandler handler: getAttribHandlers()) {
114             if (!handler.match(cookie, origin)) {
115                 return false;
116             }
117         }
118         return true;
119     }
120 
121 }
122