com.cyberway.issue.crawler.processor.recrawl.FetchHistoryProcessor.java Source code

Introduction

Here is the source code for com.cyberway.issue.crawler.processor.recrawl.FetchHistoryProcessor.java

Source

/* FetchHistoryProcessor
 * 
 * Created on Feb 12, 2005
 *
 * Copyright (C) 2007 Internet Archive.
 * 
 * This file is part of the Heritrix web crawler (crawler.archive.org).
 * 
 * Heritrix is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
 * any later version.
 * 
 * Heritrix is distributed in the hope that it will be useful, 
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser Public License
 * along with Heritrix; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
package com.cyberway.issue.crawler.processor.recrawl;

import org.apache.commons.httpclient.Header;
import org.apache.commons.httpclient.HttpMethodBase;
import org.apache.commons.httpclient.HttpState;
import org.apache.commons.httpclient.HttpStatus;
import com.cyberway.issue.crawler.datamodel.CoreAttributeConstants;
import com.cyberway.issue.crawler.datamodel.CrawlURI;
import com.cyberway.issue.crawler.framework.Processor;
import com.cyberway.issue.crawler.settings.SimpleType;

import st.ata.util.AList;
import st.ata.util.HashtableAList;

/**
 * Maintain a history of fetch information inside the CrawlURI's attributes. 
 * 
 * @author gojomo
 * @version $Date: 2006-09-25 20:19:54 +0000 (Mon, 25 Sep 2006) $, $Revision: 4654 $
 */
public class FetchHistoryProcessor extends Processor implements CoreAttributeConstants {
    private static final long serialVersionUID = 8476621038669163983L;

    /** setting for desired history array length */
    public static final String ATTR_HISTORY_LENGTH = "history-length";
    /** default history array length */
    public static final Integer DEFAULT_HISTORY_LENGTH = 2;

    /**
     * Usual constructor
     * 
     * @param name
     */
    public FetchHistoryProcessor(String name) {
        super(name, "FetchHistoryProcessor. Maintain a history of fetch "
                + "information inside the CrawlURI's attributes..");

        addElementToDefinition(new SimpleType(ATTR_HISTORY_LENGTH,
                "Number of previous fetch entries to retain in the URI "
                        + "history. The current fetch becomes a history entry at "
                        + "this Processor step, so the smallest useful value is "
                        + "'2' (including the current fetch). Default is '2'.",
                DEFAULT_HISTORY_LENGTH));
    }

    @Override
    protected void innerProcess(CrawlURI curi) throws InterruptedException {
        AList latestFetch = new HashtableAList();

        // save status
        latestFetch.putInt(A_STATUS, curi.getFetchStatus());
        // save fetch start time
        latestFetch.putLong(A_FETCH_BEGAN_TIME, curi.getLong(A_FETCH_BEGAN_TIME));
        // save digest
        String digest = curi.getContentDigestSchemeString();
        if (digest != null) {
            latestFetch.putString(A_CONTENT_DIGEST, digest);
        }
        // save relevant HTTP headers, if available
        if (curi.containsKey(A_HTTP_TRANSACTION)) {
            HttpMethodBase method = (HttpMethodBase) curi.getObject(A_HTTP_TRANSACTION);
            saveHeader(A_ETAG_HEADER, method, latestFetch);
            saveHeader(A_LAST_MODIFIED_HEADER, method, latestFetch);
            // save reference length (real or virtual)
            long referenceLength;
            if (curi.containsKey(A_REFERENCE_LENGTH)) {
                // reuse previous length if available (see FetchHTTP#setSizes). 
                referenceLength = curi.getLong(A_REFERENCE_LENGTH);
            } else {
                // normally, use content-length
                referenceLength = curi.getContentLength();
            }
            latestFetch.putLong(A_REFERENCE_LENGTH, referenceLength);
        }

        // get or create proper-sized history array
        int targetHistoryLength = (Integer) getUncheckedAttribute(curi, ATTR_HISTORY_LENGTH);
        AList[] history = curi.getAList().containsKey(A_FETCH_HISTORY)
                ? curi.getAList().getAListArray(A_FETCH_HISTORY)
                : new AList[targetHistoryLength];
        if (history.length != targetHistoryLength) {
            AList[] newHistory = new AList[targetHistoryLength];
            System.arraycopy(history, 0, newHistory, 0, Math.min(history.length, newHistory.length));
            history = newHistory;
        }

        // rotate all history entries up one slot, insert new at [0]
        for (int i = history.length - 1; i > 0; i--) {
            history[i] = history[i - 1];
        }
        history[0] = latestFetch;

        curi.getAList().putAListArray(A_FETCH_HISTORY, history);
    }

    /**
     * Save a header from the given HTTP operation into the AList.
     * 
     * @param name header name to save into history AList
     * @param method http operation containing headers
     * @param latestFetch AList to get header
     */
    protected void saveHeader(String name, HttpMethodBase method, AList latestFetch) {
        Header header = method.getResponseHeader(name);
        if (header != null) {
            latestFetch.putString(name, header.getValue());
        }
    }

    @Override
    protected void initialTasks() {
        // ensure history info persists across enqueues and recrawls
        CrawlURI.addAlistPersistentMember(A_FETCH_HISTORY);
    }

}