/*
* Copyright 2009-2013 Scale Unlimited
*
* 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.
*
*/
package bixo.fetcher;
import java.io.ByteArrayOutputStream;
import java.io.Closeable;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URI;
import java.net.URISyntaxException;
import java.net.URL;
import java.security.NoSuchAlgorithmException;
import java.util.HashSet;
import java.util.Set;
import java.util.concurrent.TimeUnit;
import javax.net.ssl.SSLContext;
import javax.net.ssl.SSLException;
import javax.net.ssl.SSLHandshakeException;
import javax.net.ssl.TrustManager;
import org.apache.http.Header;
import org.apache.http.HttpEntity;
import org.apache.http.HttpEntityEnclosingRequest;
import org.apache.http.HttpException;
import org.apache.http.HttpHost;
import org.apache.http.HttpInetConnection;
import org.apache.http.HttpRequest;
import org.apache.http.HttpRequestInterceptor;
import org.apache.http.HttpResponse;
import org.apache.http.HttpStatus;
import org.apache.http.HttpVersion;
import org.apache.http.NoHttpResponseException;
import org.apache.http.ProtocolException;
import org.apache.http.client.ClientProtocolException;
import org.apache.http.client.CookieStore;
import org.apache.http.client.HttpRequestRetryHandler;
import org.apache.http.client.RedirectException;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.methods.HttpRequestBase;
import org.apache.http.client.methods.HttpUriRequest;
import org.apache.http.client.params.ClientParamBean;
import org.apache.http.client.params.CookiePolicy;
import org.apache.http.client.params.HttpClientParams;
import org.apache.http.client.protocol.ClientContext;
import org.apache.http.conn.ConnectionPoolTimeoutException;
import org.apache.http.conn.params.ConnManagerParams;
import org.apache.http.conn.params.ConnPerRouteBean;
import org.apache.http.conn.scheme.PlainSocketFactory;
import org.apache.http.conn.scheme.Scheme;
import org.apache.http.conn.scheme.SchemeRegistry;
import org.apache.http.conn.ssl.AbstractVerifier;
import org.apache.http.conn.ssl.SSLSocketFactory;
import org.apache.http.cookie.params.CookieSpecParamBean;
import org.apache.http.impl.client.BasicCookieStore;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.impl.client.DefaultRedirectHandler;
import org.apache.http.impl.conn.tsccm.ThreadSafeClientConnManager;
import org.apache.http.message.BasicHeader;
import org.apache.http.params.BasicHttpParams;
import org.apache.http.params.HttpConnectionParams;
import org.apache.http.params.HttpParams;
import org.apache.http.params.HttpProtocolParams;
import org.apache.http.protocol.BasicHttpContext;
import org.apache.http.protocol.ExecutionContext;
import org.apache.http.protocol.HttpContext;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import bixo.config.FetcherPolicy;
import bixo.config.FetcherPolicy.RedirectMode;
import bixo.config.UserAgent;
import bixo.datum.ContentBytes;
import bixo.datum.FetchedDatum;
import bixo.datum.HttpHeaders;
import bixo.datum.ScoredUrlDatum;
import bixo.exceptions.AbortedFetchException;
import bixo.exceptions.AbortedFetchReason;
import bixo.exceptions.BaseFetchException;
import bixo.exceptions.HttpFetchException;
import bixo.exceptions.IOFetchException;
import bixo.exceptions.RedirectFetchException;
import bixo.exceptions.RedirectFetchException.RedirectExceptionReason;
import bixo.exceptions.UrlFetchException;
import bixo.utils.EncodingUtils;
import bixo.utils.EncodingUtils.ExpandedResult;
import bixo.utils.HttpUtils;
import com.scaleunlimited.cascading.Payload;
@SuppressWarnings("serial")
public class SimpleHttpFetcher extends BaseFetcher {
private static Logger LOGGER = LoggerFactory.getLogger(SimpleHttpFetcher.class);
// We tried 10 seconds for all of these, but got a number of connection/read timeouts for
// sites that would have eventually worked, so bumping it up to 30 seconds.
private static final int DEFAULT_SOCKET_TIMEOUT = 30 * 1000;
private static final int DEFAULT_CONNECTION_TIMEOUT = 30 * 1000;
private static final int DEFAULT_MAX_THREADS = 1;
// This normally don't ever hit this timeout, since we manage the number of
// fetcher threads to be <= the maxThreads value used to configure an IHttpFetcher.
// But the limit of connections/host can cause a timeout, when redirects cause
// multiple threads to hit the same domain. So jack the value way up.
private static final long CONNECTION_POOL_TIMEOUT = 100 * 1000L;
private static final int BUFFER_SIZE = 8 * 1024;
private static final int DEFAULT_MAX_RETRY_COUNT = 10;
private static final int DEFAULT_BYTEARRAY_SIZE = 32 * 1024;
// Use the same values as Firefox (except that we don't accept deflate,
// which we're not sure is implemented correctly - see the notes in
// EncodingUtils/EncodingUtilsTest for more details).
private static final String DEFAULT_ACCEPT = "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8";
private static final String DEFAULT_ACCEPT_CHARSET = "utf-8,ISO-8859-1;q=0.7,*;q=0.7";
private static final String DEFAULT_ACCEPT_ENCODING = "x-gzip, gzip";
// Keys used to access data in the HTTP execution context.
private static final String PERM_REDIRECT_CONTEXT_KEY = "perm-redirect";
private static final String REDIRECT_COUNT_CONTEXT_KEY = "redirect-count";
private static final String HOST_ADDRESS = "host-address";
private static final String SSL_CONTEXT_NAMES[] = {
"TLS",
"Default",
"SSL",
};
private static final String TEXT_MIME_TYPES[] = {
"text/html",
"application/x-asp",
"application/xhtml+xml",
"application/vnd.wap.xhtml+xml",
};
private HttpVersion _httpVersion = HttpVersion.HTTP_1_1;
private int _socketTimeout = DEFAULT_SOCKET_TIMEOUT;
private int _connectionTimeout = DEFAULT_CONNECTION_TIMEOUT;
private int _maxRetryCount = DEFAULT_MAX_RETRY_COUNT;
private String _acceptEncoding = DEFAULT_ACCEPT_ENCODING;
transient private DefaultHttpClient _httpClient;
private static class MyRequestRetryHandler implements HttpRequestRetryHandler {
private int _maxRetryCount;
public MyRequestRetryHandler(int maxRetryCount) {
_maxRetryCount = maxRetryCount;
}
@Override
public boolean retryRequest(IOException exception, int executionCount, HttpContext context) {
if (LOGGER.isTraceEnabled()) {
LOGGER.trace("Decide about retry #" + executionCount + " for exception " + exception.getMessage());
}
if (executionCount >= _maxRetryCount) {
// Do not retry if over max retry count
return false;
} else if (exception instanceof NoHttpResponseException) {
// Retry if the server dropped connection on us
return true;
} else if (exception instanceof SSLHandshakeException) {
// Do not retry on SSL handshake exception
return false;
}
HttpRequest request = (HttpRequest)context.getAttribute(ExecutionContext.HTTP_REQUEST);
boolean idempotent = !(request instanceof HttpEntityEnclosingRequest);
// Retry if the request is considered idempotent
return idempotent;
}
}
private static class MyRedirectException extends RedirectException {
private URI _uri;
private RedirectExceptionReason _reason;
public MyRedirectException(String message, URI uri, RedirectExceptionReason reason) {
super(message);
_uri = uri;
_reason = reason;
}
public URI getUri() {
return _uri;
}
public RedirectExceptionReason getReason() {
return _reason;
}
}
/**
* Handler to record last permanent redirect (if any) in context.
*
*/
private static class MyRedirectHandler extends DefaultRedirectHandler {
private RedirectMode _redirectMode;
public MyRedirectHandler(RedirectMode redirectMode) {
super();
_redirectMode = redirectMode;
}
@Override
public URI getLocationURI(HttpResponse response, HttpContext context) throws ProtocolException {
URI result = super.getLocationURI(response, context);
// HACK - some sites return a redirect with an explicit port number that's the same as
// the default port (e.g. 80 for http), and then when you use this to make the next
// request, the presence of the port in the domain triggers another redirect, so you
// fail with a circular redirect error. Avoid that by converting the port number to
// -1 in that case.
if (result.getScheme().equalsIgnoreCase("http") && (result.getPort() == 80)) {
try {
result = new URI(result.getScheme(), result.getUserInfo(), result.getHost(), -1, result.getPath(), result.getQuery(), result.getFragment());
} catch (URISyntaxException e) {
LOGGER.warn("Unexpected exception removing port from URI", e);
}
}
// Keep track of the number of redirects.
Integer count = (Integer)context.getAttribute(REDIRECT_COUNT_CONTEXT_KEY);
if (count == null) {
count = new Integer(0);
}
context.setAttribute(REDIRECT_COUNT_CONTEXT_KEY, count + 1);
// Record the last permanent redirect
int statusCode = response.getStatusLine().getStatusCode();
if (statusCode == HttpStatus.SC_MOVED_PERMANENTLY) {
context.setAttribute(PERM_REDIRECT_CONTEXT_KEY, result);
}
// Based on the redirect mode, decide how we want to handle this.
boolean isPermRedirect = statusCode == HttpStatus.SC_MOVED_PERMANENTLY;
if ((_redirectMode == RedirectMode.FOLLOW_NONE) ||
((_redirectMode == RedirectMode.FOLLOW_TEMP) && isPermRedirect)) {
RedirectExceptionReason reason = isPermRedirect ? RedirectExceptionReason.PERM_REDIRECT_DISALLOWED :
RedirectExceptionReason.TEMP_REDIRECT_DISALLOWED;
throw new MyRedirectException("RedirectMode disallowed redirect: " + _redirectMode, result, reason);
}
return result;
}
}
/**
* Interceptor to record host address in context.
*
*/
private static class MyRequestInterceptor implements HttpRequestInterceptor {
@Override
public void process(HttpRequest request,
HttpContext context)
throws HttpException, IOException {
HttpInetConnection connection
= (HttpInetConnection)(context.getAttribute(ExecutionContext.HTTP_CONNECTION));
context.setAttribute( HOST_ADDRESS,
connection.getRemoteAddress().getHostAddress());
}
}
private static class DummyX509HostnameVerifier extends AbstractVerifier {
@Override
public void verify(String host, String[] cns, String[] subjectAlts) throws SSLException {
try {
verify(host, cns, subjectAlts, false);
} catch (SSLException e) {
LOGGER.warn("Invalid SSL certificate for " + host + ": " + e.getMessage());
}
}
@Override
public final String toString() {
return "DUMMY_VERIFIER";
}
}
public SimpleHttpFetcher(UserAgent userAgent) {
this(DEFAULT_MAX_THREADS, userAgent);
}
public SimpleHttpFetcher(int maxThreads, UserAgent userAgent) {
this(maxThreads, new FetcherPolicy(), userAgent);
}
public SimpleHttpFetcher(int maxThreads, FetcherPolicy fetcherPolicy, UserAgent userAgent) {
super(maxThreads, fetcherPolicy, userAgent);
// Just to be explicit, we rely on lazy initialization of this so that
// we don't have to worry about serializing it.
_httpClient = null;
}
public HttpVersion getHttpVersion() {
return _httpVersion;
}
public void setHttpVersion(HttpVersion httpVersion) {
if (_httpClient == null) {
_httpVersion = httpVersion;
} else {
throw new IllegalStateException("Can't change HTTP version after HttpClient has been initialized");
}
}
public int getSocketTimeout() {
return _socketTimeout;
}
public void setSocketTimeout(int socketTimeoutInMs) {
if (_httpClient == null) {
_socketTimeout = socketTimeoutInMs;
} else {
throw new IllegalStateException("Can't change socket timeout after HttpClient has been initialized");
}
}
public int getConnectionTimeout() {
return _connectionTimeout;
}
public void setConnectionTimeout(int connectionTimeoutInMs) {
if (_httpClient == null) {
_connectionTimeout = connectionTimeoutInMs;
} else {
throw new IllegalStateException("Can't change connection timeout after HttpClient has been initialized");
}
}
public int getMaxRetryCount() {
return _maxRetryCount;
}
public void setMaxRetryCount(int maxRetryCount) {
_maxRetryCount = maxRetryCount;
}
/**
* Return the current value used for the ACCEPT-ENCODING request parameter.
*
* @return value, or null if none is set.
*/
public String getAcceptEncoding() {
return _acceptEncoding;
}
public void setAcceptEncoding(String acceptEncoding) {
if (_httpClient == null) {
_acceptEncoding = acceptEncoding;
} else {
throw new IllegalStateException("Can't change accept encoding after HttpClient has been initialized");
}
}
private static FetchedDatum convert(FetchedResult result) {
FetchedDatum datum = new FetchedDatum(result.getBaseUrl(), result.getFetchedUrl(), result.getFetchTime(),
result.getHeaders(), new ContentBytes(result.getContent()), result.getContentType(),
result.getResponseRate());
datum.setNewBaseUrl(result.getNewBaseUrl());
datum.setNumRedirects(result.getNumRedirects());
datum.setHostAddress(result.getHostAddress());
datum.setPayload(result.getPayload());
return datum;
}
@Override
public FetchedDatum get(ScoredUrlDatum scoredUrl) throws BaseFetchException {
return convert(request(new HttpGet(), scoredUrl));
}
private FetchedResult request(HttpRequestBase request, ScoredUrlDatum scoredUrl) throws BaseFetchException {
init();
try {
return doRequest(request, scoredUrl.getUrl(), scoredUrl.getPayload());
} catch (HttpFetchException e) {
// Don't bother generating a trace for a 404 (not found)
if (LOGGER.isTraceEnabled() && (e.getHttpStatus() != HttpStatus.SC_NOT_FOUND)) {
LOGGER.trace(String.format("Exception fetching %s (%s)", scoredUrl.getUrl(), e.getMessage()));
}
throw e;
} catch (AbortedFetchException e) {
// Don't bother reporting that we bailed because the mime-type wasn't one that we wanted.
if (e.getAbortReason() != AbortedFetchReason.INVALID_MIMETYPE) {
LOGGER.debug(String.format("Exception fetching %s (%s)", scoredUrl.getUrl(), e.getMessage()));
}
throw e;
} catch (BaseFetchException e) {
LOGGER.debug(String.format("Exception fetching %s (%s)", scoredUrl.getUrl(), e.getMessage()));
throw e;
}
}
public FetchedResult fetch(String url) throws BaseFetchException{
return fetch(new HttpGet(), url, new Payload());
}
public FetchedResult fetch(HttpRequestBase request, String url, Payload payload) throws BaseFetchException{
init();
try {
return doRequest(request, url, payload);
} catch (BaseFetchException e) {
if (LOGGER.isTraceEnabled()) {
LOGGER.trace(String.format("Exception fetching %s", url), e);
}
throw e;
}
}
private FetchedResult doRequest(HttpRequestBase request, String url, Payload payload) throws BaseFetchException {
LOGGER.trace("Fetching " + url);
HttpResponse response;
long readStartTime;
HttpHeaders headerMap = new HttpHeaders();
String redirectedUrl = null;
String newBaseUrl = null;
int numRedirects = 0;
boolean needAbort = true;
String contentType = "";
String mimeType = "";
String hostAddress = null;
// Create a local instance of cookie store, and bind to local context
// Without this we get killed w/lots of threads, due to sync() on single cookie store.
HttpContext localContext = new BasicHttpContext();
CookieStore cookieStore = new BasicCookieStore();
localContext.setAttribute(ClientContext.COOKIE_STORE, cookieStore);
StringBuilder fetchTrace = null;
if (LOGGER.isTraceEnabled()) {
fetchTrace = new StringBuilder("Fetched url: " + url);
}
try {
request.setURI(new URI(url));
readStartTime = System.currentTimeMillis();
response = _httpClient.execute(request, localContext);
Header[] headers = response.getAllHeaders();
for (Header header : headers) {
headerMap.add(header.getName(), header.getValue());
}
int httpStatus = response.getStatusLine().getStatusCode();
if (LOGGER.isTraceEnabled()) {
fetchTrace.append("; status code: " + httpStatus);
if (headerMap.getFirst(HttpHeaderNames.CONTENT_LENGTH) != null) {
fetchTrace.append("; Content-Length: " + headerMap.getFirst(HttpHeaderNames.CONTENT_LENGTH));
}
if (headerMap.getFirst(HttpHeaderNames.LOCATION) != null) {
fetchTrace.append("; Location: " + headerMap.getFirst(HttpHeaderNames.LOCATION));
}
}
if ((httpStatus < 200) || (httpStatus >= 300)) {
// We can't just check against SC_OK, as some wackos return 201, 202, etc
throw new HttpFetchException(url, "Error fetching " + url, httpStatus, headerMap);
}
redirectedUrl = extractRedirectedUrl(url, localContext);
URI permRedirectUri = (URI)localContext.getAttribute(PERM_REDIRECT_CONTEXT_KEY);
if (permRedirectUri != null) {
newBaseUrl = permRedirectUri.toURL().toExternalForm();
}
Integer redirects = (Integer)localContext.getAttribute(REDIRECT_COUNT_CONTEXT_KEY);
if (redirects != null) {
numRedirects = redirects.intValue();
}
hostAddress = (String)(localContext.getAttribute(HOST_ADDRESS));
if (hostAddress == null) {
throw new UrlFetchException(url, "Host address not saved in context");
}
Header cth = response.getFirstHeader(HttpHeaderNames.CONTENT_TYPE);
if (cth != null) {
contentType = cth.getValue();
}
// Check if we should abort due to mime-type filtering. Note that this will fail if the server
// doesn't report a mime-type, but that's how we want it as this configuration is typically
// used when only a subset of parsers are installed/enabled, so we don't want the auto-detect
// code in Tika to get triggered & try to process an unsupported type. If you want unknown
// mime-types from the server to be processed, set "" as one of the valid mime-types in FetcherPolicy.
mimeType = HttpUtils.getMimeTypeFromContentType(contentType);
Set<String> mimeTypes = _fetcherPolicy.getValidMimeTypes();
if ((mimeTypes != null) && (mimeTypes.size() > 0)) {
if (!mimeTypes.contains(mimeType)) {
throw new AbortedFetchException(url, "Invalid mime-type: " + mimeType, AbortedFetchReason.INVALID_MIMETYPE);
}
}
needAbort = false;
} catch (ClientProtocolException e) {
// Oleg guarantees that no abort is needed in the case of an IOException (which is is a subclass of)
needAbort = false;
// If the root case was a "too many redirects" error, we want to map this to a specific
// exception that contains the final redirect.
if (e.getCause() instanceof MyRedirectException) {
MyRedirectException mre = (MyRedirectException)e.getCause();
String redirectUrl = url;
try {
redirectUrl = mre.getUri().toURL().toExternalForm();
} catch (MalformedURLException e2) {
LOGGER.warn("Invalid URI saved during redirect handling: " + mre.getUri());
}
throw new RedirectFetchException(url, redirectUrl, mre.getReason());
} else if (e.getCause() instanceof RedirectException) {
throw new RedirectFetchException(url, extractRedirectedUrl(url, localContext), RedirectExceptionReason.TOO_MANY_REDIRECTS);
} else {
throw new IOFetchException(url, e);
}
} catch (IOException e) {
// Oleg guarantees that no abort is needed in the case of an IOException
needAbort = false;
if (e instanceof ConnectionPoolTimeoutException) {
// Should never happen, so let's dump some info about the connection pool.
ThreadSafeClientConnManager cm = (ThreadSafeClientConnManager)_httpClient.getConnectionManager();
int numConnections = cm.getConnectionsInPool();
cm.closeIdleConnections(0, TimeUnit.MILLISECONDS);
LOGGER.error(String.format("Got ConnectionPoolTimeoutException: %d connections before, %d after idle close", numConnections, cm.getConnectionsInPool()));
}
throw new IOFetchException(url, e);
} catch (URISyntaxException e) {
throw new UrlFetchException(url, e.getMessage());
} catch (IllegalStateException e) {
throw new UrlFetchException(url, e.getMessage());
} catch (BaseFetchException e) {
throw e;
} catch (Exception e) {
// Map anything else to a generic IOFetchException
// TODO KKr - create generic fetch exception
throw new IOFetchException(url, new IOException(e));
} finally {
safeAbort(needAbort, request);
}
// Figure out how much data we want to try to fetch.
int maxContentSize = getMaxContentSize(mimeType);
int targetLength = maxContentSize;
boolean truncated = false;
String contentLengthStr = headerMap.getFirst(HttpHeaderNames.CONTENT_LENGTH);
if (contentLengthStr != null) {
try {
int contentLength = Integer.parseInt(contentLengthStr);
if (contentLength > targetLength) {
truncated = true;
} else {
targetLength = contentLength;
}
} catch (NumberFormatException e) {
// Ignore (and log) invalid content length values.
LOGGER.warn("Invalid content length in header: " + contentLengthStr);
}
}
// Now finally read in response body, up to targetLength bytes.
// Note that entity might be null, for zero length responses.
byte[] content = new byte[0];
long readRate = 0;
HttpEntity entity = response.getEntity();
needAbort = true;
if (entity != null) {
InputStream in = null;
try {
in = entity.getContent();
byte[] buffer = new byte[BUFFER_SIZE];
int bytesRead = 0;
int totalRead = 0;
ByteArrayOutputStream out = new ByteArrayOutputStream(DEFAULT_BYTEARRAY_SIZE);
int readRequests = 0;
int minResponseRate = _fetcherPolicy.getMinResponseRate();
// TODO KKr - we need to monitor the rate while reading a
// single block. Look at HttpClient
// metrics support for how to do this. Once we fix this, fix
// the test to read a smaller (< 20K)
// chuck of data.
while ((totalRead < targetLength)
&& ((bytesRead = in.read(buffer, 0, Math.min(buffer.length, targetLength - totalRead))) != -1)) {
readRequests += 1;
totalRead += bytesRead;
out.write(buffer, 0, bytesRead);
// Assume read time is at least one millisecond, to avoid DBZ exception.
long totalReadTime = Math.max(1, System.currentTimeMillis() - readStartTime);
readRate = (totalRead * 1000L) / totalReadTime;
// Don't bail on the first read cycle, as we can get a hiccup starting out.
// Also don't bail if we've read everything we need.
if ((readRequests > 1) && (totalRead < targetLength) && (readRate < minResponseRate)) {
throw new AbortedFetchException(url, "Slow response rate of " + readRate + " bytes/sec", AbortedFetchReason.SLOW_RESPONSE_RATE);
}
// Check to see if we got interrupted.
if (Thread.interrupted()) {
throw new AbortedFetchException(url, AbortedFetchReason.INTERRUPTED);
}
}
content = out.toByteArray();
needAbort = truncated || (in.available() > 0);
} catch (IOException e) {
// We don't need to abort if there's an IOException
throw new IOFetchException(url, e);
} finally {
safeAbort(needAbort, request);
safeClose(in);
}
}
// Toss truncated image content.
if ( (truncated)
&& (!isTextMimeType(mimeType))) {
throw new AbortedFetchException(url, "Truncated image", AbortedFetchReason.CONTENT_SIZE);
}
// Now see if we need to uncompress the content.
String contentEncoding = headerMap.getFirst(HttpHeaderNames.CONTENT_ENCODING);
if (contentEncoding != null) {
if (LOGGER.isTraceEnabled()) {
fetchTrace.append("; Content-Encoding: " + contentEncoding);
}
// TODO KKr We might want to just decompress a truncated gzip
// containing text (since we have a max content size to save us
// from any gzip corruption). We might want to break the following
// out into a separate method, by the way (if not refactor this
// entire monolithic method).
//
try {
if ("gzip".equals(contentEncoding) || "x-gzip".equals(contentEncoding)) {
if (truncated) {
throw new AbortedFetchException(url, "Truncated compressed data", AbortedFetchReason.CONTENT_SIZE);
} else {
ExpandedResult expandedResult = EncodingUtils.processGzipEncoded(content, maxContentSize);
truncated = expandedResult.isTruncated();
if ( (truncated)
&& (!isTextMimeType(mimeType))) {
throw new AbortedFetchException(url, "Truncated decompressed image", AbortedFetchReason.CONTENT_SIZE);
} else {
content = expandedResult.getExpanded();
if (LOGGER.isTraceEnabled()) {
fetchTrace.append("; unzipped to " + content.length + " bytes");
}
}
// } else if ("deflate".equals(contentEncoding)) {
// content = EncodingUtils.processDeflateEncoded(content);
// if (LOGGER.isTraceEnabled()) {
// fetchTrace.append("; inflated to " + content.length + " bytes");
// }
}
}
} catch (IOException e) {
throw new IOFetchException(url, e);
}
}
// Finally dump out the trace msg we've been building.
if (LOGGER.isTraceEnabled()) {
LOGGER.trace(fetchTrace.toString());
}
// TODO KKr - Save truncated flag in FetchedResult/FetchedDatum.
return new FetchedResult( url,
redirectedUrl,
System.currentTimeMillis(),
headerMap,
content,
contentType,
(int)readRate,
payload,
newBaseUrl,
numRedirects,
hostAddress);
}
private boolean isTextMimeType(String mimeType) {
for (String textContentType : TEXT_MIME_TYPES) {
if (textContentType.equals(mimeType)) {
return true;
}
}
return false;
}
private String extractRedirectedUrl(String url, HttpContext localContext) {
// This was triggered by HttpClient with the redirect count was exceeded.
HttpHost host = (HttpHost)localContext.getAttribute(ExecutionContext.HTTP_TARGET_HOST);
HttpUriRequest finalRequest = (HttpUriRequest)localContext.getAttribute(ExecutionContext.HTTP_REQUEST);
try {
URL hostUrl = new URI(host.toURI()).toURL();
return new URL(hostUrl, finalRequest.getURI().toString()).toExternalForm();
} catch (MalformedURLException e) {
LOGGER.warn("Invalid host/uri specified in final fetch: " + host + finalRequest.getURI());
return url;
} catch (URISyntaxException e) {
LOGGER.warn("Invalid host/uri specified in final fetch: " + host + finalRequest.getURI());
return url;
}
}
private static void safeClose(Closeable o) {
if (o != null) {
try {
o.close();
} catch (Exception e) {
// Ignore any errors
}
}
}
private static void safeAbort(boolean needAbort, HttpRequestBase request) {
if (needAbort && (request != null)) {
try {
request.abort();
} catch (Throwable t) {
// Ignore any errors
}
}
}
private synchronized void init() {
if (_httpClient == null) {
// Create and initialize HTTP parameters
HttpParams params = new BasicHttpParams();
// TODO KKr - w/4.1, switch to new api (ThreadSafeClientConnManager)
// cm.setMaxTotalConnections(_maxThreads);
// cm.setDefaultMaxPerRoute(Math.max(10, _maxThreads/10));
// And get rid of deprecation warnings here.
ConnManagerParams.setMaxTotalConnections(params, _maxThreads);
// Set the maximum time we'll wait for a spare connection in the connection pool. We
// shouldn't actually hit this, as we make sure (in FetcherManager) that the max number
// of active requests doesn't exceed the value returned by getMaxThreads() here.
ConnManagerParams.setTimeout(params, CONNECTION_POOL_TIMEOUT);
// Set the socket and connection timeout to be something reasonable.
HttpConnectionParams.setSoTimeout(params, _socketTimeout);
HttpConnectionParams.setConnectionTimeout(params, _connectionTimeout);
// Even with stale checking enabled, a connection can "go stale" between the check and the
// next request. So we still need to handle the case of a closed socket (from the server side),
// and disabling this check improves performance.
HttpConnectionParams.setStaleCheckingEnabled(params, false);
// FUTURE - set this on a per-route (host) basis when we have per-host policies for
// doing partner crawls. We could define a BixoConnPerRoute class that supports this.
ConnPerRouteBean connPerRoute = new ConnPerRouteBean(_fetcherPolicy.getMaxConnectionsPerHost());
ConnManagerParams.setMaxConnectionsPerRoute(params, connPerRoute);
HttpProtocolParams.setVersion(params, _httpVersion);
HttpProtocolParams.setUserAgent(params, _userAgent.getUserAgentString());
HttpProtocolParams.setContentCharset(params, "UTF-8");
HttpProtocolParams.setHttpElementCharset(params, "UTF-8");
HttpProtocolParams.setUseExpectContinue(params, true);
// TODO KKr - set on connection manager params, or client params?
CookieSpecParamBean cookieParams = new CookieSpecParamBean(params);
cookieParams.setSingleHeader(true);
// Create and initialize scheme registry
SchemeRegistry schemeRegistry = new SchemeRegistry();
schemeRegistry.register(new Scheme("http", PlainSocketFactory.getSocketFactory(), 80));
SSLSocketFactory sf = null;
for (String contextName : SSL_CONTEXT_NAMES) {
try {
SSLContext sslContext = SSLContext.getInstance(contextName);
sslContext.init(null, new TrustManager[] { new DummyX509TrustManager(null) }, null);
sf = new SSLSocketFactory(sslContext);
break;
} catch (NoSuchAlgorithmException e) {
LOGGER.debug("SSLContext algorithm not available: " + contextName);
} catch (Exception e) {
LOGGER.debug("SSLContext can't be initialized: " + contextName, e);
}
}
if (sf != null) {
sf.setHostnameVerifier(new DummyX509HostnameVerifier());
schemeRegistry.register(new Scheme("https", sf, 443));
} else {
LOGGER.warn("No valid SSLContext found for https");
}
// Use ThreadSafeClientConnManager since more than one thread will be using the HttpClient.
ThreadSafeClientConnManager cm = new ThreadSafeClientConnManager(params, schemeRegistry);
_httpClient = new DefaultHttpClient(cm, params);
_httpClient.setHttpRequestRetryHandler(new MyRequestRetryHandler(_maxRetryCount));
_httpClient.setRedirectHandler(new MyRedirectHandler(_fetcherPolicy.getRedirectMode()));
_httpClient.addRequestInterceptor(new MyRequestInterceptor());
params = _httpClient.getParams();
// FUTURE KKr - support authentication
HttpClientParams.setAuthenticating(params, false);
// We're ignoring cookies, since we don't use them for requests.
HttpClientParams.setCookiePolicy(params, CookiePolicy.IGNORE_COOKIES);
ClientParamBean clientParams = new ClientParamBean(params);
if (_fetcherPolicy.getMaxRedirects() == 0) {
clientParams.setHandleRedirects(false);
} else {
clientParams.setHandleRedirects(true);
clientParams.setMaxRedirects(_fetcherPolicy.getMaxRedirects());
}
// Set up default headers. This helps us get back from servers what we want.
HashSet<Header> defaultHeaders = new HashSet<Header>();
defaultHeaders.add(new BasicHeader(HttpHeaderNames.ACCEPT_LANGUAGE, _fetcherPolicy.getAcceptLanguage()));
defaultHeaders.add(new BasicHeader(HttpHeaderNames.ACCEPT_CHARSET, DEFAULT_ACCEPT_CHARSET));
defaultHeaders.add(new BasicHeader(HttpHeaderNames.ACCEPT_ENCODING, _acceptEncoding));
defaultHeaders.add(new BasicHeader(HttpHeaderNames.ACCEPT, DEFAULT_ACCEPT));
clientParams.setDefaultHeaders(defaultHeaders);
}
}
@Override
public void abort() {
// TODO Actually try to abort
}
}