httpstate.java

爬虫

/*
 * $Header: /cvsroot/archive-crawler/ArchiveOpenCrawler/src/java/org/apache/commons/httpclient/HttpState.java,v 1.1 2005/06/06 17:50:02 gojomo Exp $
 * $Revision: 1.1 $
 * $Date: 2005/06/06 17:50:02 $
 *
 * ====================================================================
 *
 *  Copyright 1999-2004 The Apache Software Foundation
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 *
 */

package org.apache.commons.httpclient;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.Date;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
import java.util.List;
import java.util.Iterator;
import java.util.SortedMap;
import java.util.TreeMap;

import org.apache.commons.httpclient.cookie.CookieSpec;
import org.apache.commons.httpclient.cookie.CookiePolicy;
import org.apache.commons.httpclient.auth.AuthScope; 
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

import com.sleepycat.collections.StoredIterator;

/**
 * <p>
 * A container for HTTP attributes that may persist from request
 * to request, such as {@link Cookie cookies} and authentication
 * {@link Credentials credentials}.
 * </p>
 * 
 * @author <a href="mailto:[e-mail]">Remy Maucherat</a>
 * @author Rodney Waldhoff
 * @author <a href="mailto:[e-mail]">Jeff Dever</a>
 * @author Sean C. Sullivan
 * @author <a href="mailto:[e-mail]">Michael Becke</a>
 * @author <a href="mailto:[e-mail]">Oleg Kalnichevski</a>
 * @author <a href="mailto:[e-mail]">Mike Bowler</a>
 * @author <a href="mailto:[e-mail]">Adrian Sutton</a>
 * 
 * @version $Revision: 1.1 $ $Date: 2005/06/06 17:50:02 $
 * 
 */
public class HttpState {

    // ----------------------------------------------------- Instance Variables

    /**
     * Map of {@link Credentials credentials} by realm that this 
     * HTTP state contains.
     */
    private HashMap credMap = new HashMap();

    /**
     * Map of {@link Credentials proxy credentials} by realm that this
     * HTTP state contains
     */
    private HashMap proxyCred = new HashMap();

// BEGIN IA CHANGES
//    /**
//     * Array of {@link Cookie cookies} that this HTTP state contains.
//     */
//    private ArrayList cookiesArrayList = new ArrayList();
    /**
     * SortedMap of {@link Cookie cookies} that this HTTP state contains.
     */
    private SortedMap cookiesMap = new TreeMap();
// END IA CHANGES
    
    private boolean preemptive = false;

    private int cookiePolicy = -1;
        // -------------------------------------------------------- Class Variables

    /**
     * The boolean system property name to turn on preemptive authentication.
     * @deprecated This field and feature will be removed following HttpClient 3.0.
     */
    public static final String PREEMPTIVE_PROPERTY = "httpclient.authentication.preemptive";

    /**
     * The default value for {@link #PREEMPTIVE_PROPERTY}.
     * @deprecated This field and feature will be removed following HttpClient 3.0.
     */
    public static final String PREEMPTIVE_DEFAULT = "false";
    
    /** Log object for this class. */
    private static final Log LOG = LogFactory.getLog(HttpState.class);

    /**
     * Default constructor.
     */
    public HttpState() {
        super();
    }

    // ------------------------------------------------------------- Properties

    /**
     * Adds an {@link Cookie HTTP cookie}, replacing any existing equivalent cookies.
     * If the given cookie has already expired it will not be added, but existing 
     * values will still be removed.
     * 
     * @param cookie the {@link Cookie cookie} to be added
     * 
     * @see #addCookies(Cookie[])
     * 
     */
    public synchronized void addCookie(Cookie cookie) {
        LOG.trace("enter HttpState.addCookie(Cookie)");

// BEGIN IA CHANGES
// PRIOR IMPL & COMPARISON HARNESS LEFT COMMENTED OUT FOR TEMPORARY REFERENCE
//        Cookie removed1 = null;
        Cookie removed2 = null;
        if (cookie != null) {
            // first remove any old cookie that is equivalent
//            for (Iterator it = cookiesArrayList.iterator(); it.hasNext();) {
//                Cookie tmp = (Cookie) it.next();
//                if (cookie.equals(tmp)) {
//                    it.remove();
//                    removed1 = tmp;
//                    break;
//                }
//            }
            if (!cookie.isExpired()) {
//                cookiesArrayList.add(cookie);
                removed2 = (Cookie) cookiesMap.put(cookie.getSortKey(),cookie);
            } else {
                removed2 = (Cookie) cookiesMap.remove(cookie.getSortKey());
            }
        }
//        if(removed1!=null && !removed1.equals(removed2)) {
//            System.out.println("addCookie discrepancy");
//        }
// END IA CHANGES
    }

    /**
     * Adds an array of {@link Cookie HTTP cookies}. Cookies are added individually and 
     * in the given array order. If any of the given cookies has already expired it will 
     * not be added, but existing values will still be removed.
     * 
     * @param cookies the {@link Cookie cookies} to be added
     * 
     * @see #addCookie(Cookie)
     * 
     * 
     */
    public synchronized void addCookies(Cookie[] cookies) {
        LOG.trace("enter HttpState.addCookies(Cookie[])");

        if (cookies != null) {
            for (int i = 0; i < cookies.length; i++) {
                this.addCookie(cookies[i]);
            }
        }
    }

    /**
     * Returns an array of {@link Cookie cookies} that this HTTP
     * state currently contains.
     * 
     * @return an array of {@link Cookie cookies}.
     * 
     * @see #getCookies(String, int, String, boolean)
     * 
     * @deprecated use getCookiesMap()
     */
    public synchronized Cookie[] getCookies() {
        LOG.trace("enter HttpState.getCookies()");
// BEGIN IA CHANGES
//      PRIOR IMPL & COMPARISON HARNESS LEFT COMMENTED OUT FOR TEMPORARY REFERENCE
//        Cookie[] arrayListAnswer = (Cookie[]) (cookiesArrayList.toArray(new Cookie[cookiesArrayList.size()]));
        ArrayList arrayableCookies = new ArrayList();
        Iterator iter = cookiesMap.values().iterator();
        while(iter.hasNext()) {
            arrayableCookies.add(iter.next());
        }
        StoredIterator.close(iter);
        Cookie[] mapAnswer = 
            (Cookie[]) arrayableCookies.toArray(new Cookie[arrayableCookies.size()]);
        
//        if(cookiesArrayList.size()!=arrayableCookies.size()) {
//            System.out.println("discrepancy");
//        }
        return mapAnswer;
// END IA CHANGES    
    }

    /**
     * Returns a sorted map of {@link Cookie cookies} that this HTTP
     * state currently contains.
     * 
     * Any operations on this map should be synchronized with respect 
     * to this HttpState instance.
     * 
     * @return sorter map of {@link Cookie cookies}
     */
    public synchronized SortedMap getCookiesMap() {
        return cookiesMap;
    }
    
    /**
     * Replace the standard sorted map with an external implemenations 
     * (such as one backed by persistent store, like BDB's StoredSortedMap.)
     * 
     * @param map alternate sorted map to use to store cookies
     */
    public synchronized void setCookiesMap(SortedMap map) {
        this.cookiesMap = map;
    }
    
    /**
     * Returns an array of {@link Cookie cookies} in this HTTP 
     * state that match the given request parameters.
     * 
     * @param domain the request domain
     * @param port the request port
     * @param path the request path
     * @param secure <code>true</code> when using HTTPS
     * 
     * @return an array of {@link Cookie cookies}.
     * 
     * @see #getCookies()
     * 
     * @deprecated use CookieSpec#match(String, int, String, boolean, Cookie)
     */
    public synchronized Cookie[] getCookies(
        String domain, 
        int port, 
        String path, 
        boolean secure
    ) {
        LOG.trace("enter HttpState.getCookies(String, int, String, boolean)");

        CookieSpec matcher = CookiePolicy.getDefaultSpec();
// BEGIN IA CHANGES
//      PRIOR IMPL & COMPARISON HARNESS LEFT COMMENTED OUT FOR TEMPORARY REFERENCE
//        ArrayList list = new ArrayList(cookiesArrayList.size());
//        for (int i = 0, m = cookiesArrayList.size(); i < m; i++) {
//            Cookie cookie = (Cookie) (cookiesArrayList.get(i));
//            if (matcher.match(domain, port, path, secure, cookie)) {
//                list.add(cookie);
//            }
//        }
//        Cookie[] arrayListAnswer = (Cookie[]) (list.toArray(new Cookie[list.size()]));
        Cookie[] mapAnswer = matcher.match(domain,port,path,secure,cookiesMap);

//        if(! (new HashSet(list).equals(new HashSet(Arrays.asList(mapAnswer))))) {
//            System.out.println("discrepancy");
//        }
        return mapAnswer;
// END IA CHANGES
    }

    /**
     * Removes all of {@link Cookie cookies} in this HTTP state
     * that have expired according to the current system time.
     * 
     * @see #purgeExpiredCookies(java.util.Date)
     * 
     */
    public synchronized boolean purgeExpiredCookies() {
        LOG.trace("enter HttpState.purgeExpiredCookies()");
        return purgeExpiredCookies(new Date());
    }

    /**
     * Removes all of {@link Cookie cookies} in this HTTP state
     * that have expired by the specified {@link java.util.Date date}. 
     * 
     * @param date The {@link java.util.Date date} to compare against.
     * 
     * @return true if any cookies were purged.
     * 
     * @see Cookie#isExpired(java.util.Date)
     * 
     * @see #purgeExpiredCookies()
     */
    public synchronized boolean purgeExpiredCookies(Date date) {
        LOG.trace("enter HttpState.purgeExpiredCookies(Date)");
// BEGIN IA CHANGES
//      PRIOR IMPL & COMPARISON HARNESS LEFT COMMENTED OUT FOR TEMPORARY REFERENCE
//        boolean arrayRemoved = false;
//        Iterator ita = cookiesArrayList.iterator();
//        while (ita.hasNext()) {
//            if (((Cookie) (ita.next())).isExpired(date)) {
//                ita.remove();
//                arrayRemoved = true;
//            }
//        }
        boolean removed = false;
        Iterator it = cookiesMap.values().iterator();
        while (it.hasNext()) {
            if (((Cookie) (it.next())).isExpired(date)) {
                it.remove();
                removed = true;
            }
        }
        StoredIterator.close(it);
//        assert removed == arrayRemoved : "discrepancy"     
// END IA CHANGES
        return removed;
    }


    /**
     * Returns the current {@link CookiePolicy cookie policy} for this
     * HTTP state.
     * 
     * @return The {@link CookiePolicy cookie policy}.
     * 
     * @deprecated Use 
     *  {@link org.apache.commons.httpclient.params.HttpMethodParams#getCookiePolicy()},
     *  {@link HttpMethod#getParams()}.     
     */
    
    public int getCookiePolicy() {
        return this.cookiePolicy;
    }
    

    /**
     * Defines whether preemptive authentication should be 
     * attempted.
     * 
     * @param value <tt>true</tt> if preemptive authentication should be 
     * attempted, <tt>false</tt> otherwise. 
     *