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: package ch.boye.httpclientandroidlib.impl.cookie;
michael@0: 
michael@0: import java.util.Locale;
michael@0: import java.util.StringTokenizer;
michael@0: 
michael@0: import ch.boye.httpclientandroidlib.annotation.Immutable;
michael@0: 
michael@0: import ch.boye.httpclientandroidlib.cookie.Cookie;
michael@0: import ch.boye.httpclientandroidlib.cookie.CookieOrigin;
michael@0: import ch.boye.httpclientandroidlib.cookie.CookieRestrictionViolationException;
michael@0: import ch.boye.httpclientandroidlib.cookie.MalformedCookieException;
michael@0: 
michael@0: /**
michael@0:  *
michael@0:  * @since 4.0
michael@0:  */
michael@0: @Immutable
michael@0: public class NetscapeDomainHandler extends BasicDomainHandler {
michael@0: 
michael@0:     public NetscapeDomainHandler() {
michael@0:         super();
michael@0:     }
michael@0: 
michael@0:     @Override
michael@0:     public void validate(final Cookie cookie, final CookieOrigin origin)
michael@0:             throws MalformedCookieException {
michael@0:         super.validate(cookie, origin);
michael@0:         // Perform Netscape Cookie draft specific validation
michael@0:         String host = origin.getHost();
michael@0:         String domain = cookie.getDomain();
michael@0:         if (host.contains(".")) {
michael@0:             int domainParts = new StringTokenizer(domain, ".").countTokens();
michael@0: 
michael@0:             if (isSpecialDomain(domain)) {
michael@0:                 if (domainParts < 2) {
michael@0:                     throw new CookieRestrictionViolationException("Domain attribute \""
michael@0:                         + domain
michael@0:                         + "\" violates the Netscape cookie specification for "
michael@0:                         + "special domains");
michael@0:                 }
michael@0:             } else {
michael@0:                 if (domainParts < 3) {
michael@0:                     throw new CookieRestrictionViolationException("Domain attribute \""
michael@0:                         + domain
michael@0:                         + "\" violates the Netscape cookie specification");
michael@0:                 }
michael@0:             }
michael@0:         }
michael@0:     }
michael@0: 
michael@0:    /**
michael@0:     * Checks if the given domain is in one of the seven special
michael@0:     * top level domains defined by the Netscape cookie specification.
michael@0:     * @param domain The domain.
michael@0:     * @return True if the specified domain is "special"
michael@0:     */
michael@0:    private static boolean isSpecialDomain(final String domain) {
michael@0:        final String ucDomain = domain.toUpperCase(Locale.ENGLISH);
michael@0:        return ucDomain.endsWith(".COM")
michael@0:                || ucDomain.endsWith(".EDU")
michael@0:                || ucDomain.endsWith(".NET")
michael@0:                || ucDomain.endsWith(".GOV")
michael@0:                || ucDomain.endsWith(".MIL")
michael@0:                || ucDomain.endsWith(".ORG")
michael@0:                || ucDomain.endsWith(".INT");
michael@0:    }
michael@0: 
michael@0:    @Override
michael@0:    public boolean match(Cookie cookie, 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:        String host = origin.getHost();
michael@0:        String domain = cookie.getDomain();
michael@0:        if (domain == null) {
michael@0:            return false;
michael@0:        }
michael@0:        return host.endsWith(domain);
michael@0:    }
michael@0: 
michael@0: }