michael@0: /*
michael@0:  * ====================================================================
michael@0:  * Licensed to the Apache Software Foundation (ASF) under one
michael@0:  * or more contributor license agreements.  See the NOTICE file
michael@0:  * distributed with this work for additional information
michael@0:  * regarding copyright ownership.  The ASF licenses this file
michael@0:  * to you under the Apache License, Version 2.0 (the
michael@0:  * "License"); you may not use this file except in compliance
michael@0:  * with the License.  You may obtain a copy of the License at
michael@0:  *
michael@0:  *   http://www.apache.org/licenses/LICENSE-2.0
michael@0:  *
michael@0:  * Unless required by applicable law or agreed to in writing,
michael@0:  * software distributed under the License is distributed on an
michael@0:  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
michael@0:  * KIND, either express or implied.  See the License for the
michael@0:  * specific language governing permissions and limitations
michael@0:  * under the License.
michael@0:  * ====================================================================
michael@0:  *
michael@0:  * This software consists of voluntary contributions made by many
michael@0:  * individuals on behalf of the Apache Software Foundation.  For more
michael@0:  * information on the Apache Software Foundation, please see
michael@0:  * <http://www.apache.org/>.
michael@0:  *
michael@0:  */
michael@0: 
michael@0: package ch.boye.httpclientandroidlib.impl.cookie;
michael@0: 
michael@0: import java.util.ArrayList;
michael@0: import java.util.List;
michael@0: import java.util.Locale;
michael@0: 
michael@0: import ch.boye.httpclientandroidlib.annotation.NotThreadSafe;
michael@0: 
michael@0: import ch.boye.httpclientandroidlib.HeaderElement;
michael@0: import ch.boye.httpclientandroidlib.NameValuePair;
michael@0: import ch.boye.httpclientandroidlib.cookie.Cookie;
michael@0: import ch.boye.httpclientandroidlib.cookie.CookieAttributeHandler;
michael@0: import ch.boye.httpclientandroidlib.cookie.CookieOrigin;
michael@0: import ch.boye.httpclientandroidlib.cookie.MalformedCookieException;
michael@0: 
michael@0: /**
michael@0:  * Cookie management functions shared by all specification.
michael@0:  *
michael@0:  *
michael@0:  * @since 4.0
michael@0:  */
michael@0: @NotThreadSafe // AbstractCookieSpec is not thread-safe
michael@0: public abstract class CookieSpecBase extends AbstractCookieSpec {
michael@0: 
michael@0:     protected static String getDefaultPath(final CookieOrigin origin) {
michael@0:         String defaultPath = origin.getPath();
michael@0:         int lastSlashIndex = defaultPath.lastIndexOf('/');
michael@0:         if (lastSlashIndex >= 0) {
michael@0:             if (lastSlashIndex == 0) {
michael@0:                 //Do not remove the very first slash
michael@0:                 lastSlashIndex = 1;
michael@0:             }
michael@0:             defaultPath = defaultPath.substring(0, lastSlashIndex);
michael@0:         }
michael@0:         return defaultPath;
michael@0:     }
michael@0: 
michael@0:     protected static String getDefaultDomain(final CookieOrigin origin) {
michael@0:         return origin.getHost();
michael@0:     }
michael@0: 
michael@0:     protected List<Cookie> parse(final HeaderElement[] elems, final CookieOrigin origin)
michael@0:                 throws MalformedCookieException {
michael@0:         List<Cookie> cookies = new ArrayList<Cookie>(elems.length);
michael@0:         for (HeaderElement headerelement : elems) {
michael@0:             String name = headerelement.getName();
michael@0:             String value = headerelement.getValue();
michael@0:             if (name == null || name.length() == 0) {
michael@0:                 throw new MalformedCookieException("Cookie name may not be empty");
michael@0:             }
michael@0: 
michael@0:             BasicClientCookie cookie = new BasicClientCookie(name, value);
michael@0:             cookie.setPath(getDefaultPath(origin));
michael@0:             cookie.setDomain(getDefaultDomain(origin));
michael@0: 
michael@0:             // cycle through the parameters
michael@0:             NameValuePair[] attribs = headerelement.getParameters();
michael@0:             for (int j = attribs.length - 1; j >= 0; j--) {
michael@0:                 NameValuePair attrib = attribs[j];
michael@0:                 String s = attrib.getName().toLowerCase(Locale.ENGLISH);
michael@0: 
michael@0:                 cookie.setAttribute(s, attrib.getValue());
michael@0: 
michael@0:                 CookieAttributeHandler handler = findAttribHandler(s);
michael@0:                 if (handler != null) {
michael@0:                     handler.parse(cookie, attrib.getValue());
michael@0:                 }
michael@0:             }
michael@0:             cookies.add(cookie);
michael@0:         }
michael@0:         return cookies;
michael@0:     }
michael@0: 
michael@0:     public void validate(final Cookie cookie, final CookieOrigin origin)
michael@0:             throws MalformedCookieException {
michael@0:         if (cookie == null) {
michael@0:             throw new IllegalArgumentException("Cookie may not be null");
michael@0:         }
michael@0:         if (origin == null) {
michael@0:             throw new IllegalArgumentException("Cookie origin may not be null");
michael@0:         }
michael@0:         for (CookieAttributeHandler handler: getAttribHandlers()) {
michael@0:             handler.validate(cookie, origin);
michael@0:         }
michael@0:     }
michael@0: 
michael@0:     public boolean match(final Cookie cookie, final CookieOrigin origin) {
michael@0:         if (cookie == null) {
michael@0:             throw new IllegalArgumentException("Cookie may not be null");
michael@0:         }
michael@0:         if (origin == null) {
michael@0:             throw new IllegalArgumentException("Cookie origin may not be null");
michael@0:         }
michael@0:         for (CookieAttributeHandler handler: getAttribHandlers()) {
michael@0:             if (!handler.match(cookie, origin)) {
michael@0:                 return false;
michael@0:             }
michael@0:         }
michael@0:         return true;
michael@0:     }
michael@0: 
michael@0: }