1 files changed, 376 insertions, 0 deletions
diff --git a/mobile/android/thirdparty/ch/boye/httpclientandroidlib/impl/client/cache/BasicHttpCache.java b/mobile/android/thirdparty/ch/boye/httpclientandroidlib/impl/client/cache/BasicHttpCache.java
new file mode 100644
index 000000000..4347e173d
--- /dev/null
+++ b/mobile/android/thirdparty/ch/boye/httpclientandroidlib/impl/client/cache/BasicHttpCache.java
@@ -0,0 +1,376 @@
+/*
+ * ====================================================================
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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 ch.boye.httpclientandroidlib.impl.client.cache;
+
+import java.io.IOException;
+import java.util.Arrays;
+import java.util.Date;
+import java.util.HashMap;
+import java.util.HashSet;
+import java.util.Map;
+import java.util.Set;
+
+import ch.boye.httpclientandroidlib.androidextra.HttpClientAndroidLog;
+/* LogFactory removed by HttpClient for Android script. */
+import ch.boye.httpclientandroidlib.Header;
+import ch.boye.httpclientandroidlib.HttpHost;
+import ch.boye.httpclientandroidlib.HttpRequest;
+import ch.boye.httpclientandroidlib.HttpResponse;
+import ch.boye.httpclientandroidlib.HttpStatus;
+import ch.boye.httpclientandroidlib.HttpVersion;
+import ch.boye.httpclientandroidlib.client.cache.HeaderConstants;
+import ch.boye.httpclientandroidlib.client.cache.HttpCacheEntry;
+import ch.boye.httpclientandroidlib.client.cache.HttpCacheInvalidator;
+import ch.boye.httpclientandroidlib.client.cache.HttpCacheStorage;
+import ch.boye.httpclientandroidlib.client.cache.HttpCacheUpdateCallback;
+import ch.boye.httpclientandroidlib.client.cache.HttpCacheUpdateException;
+import ch.boye.httpclientandroidlib.client.cache.Resource;
+import ch.boye.httpclientandroidlib.client.cache.ResourceFactory;
+import ch.boye.httpclientandroidlib.client.methods.CloseableHttpResponse;
+import ch.boye.httpclientandroidlib.entity.ByteArrayEntity;
+import ch.boye.httpclientandroidlib.message.BasicHttpResponse;
+import ch.boye.httpclientandroidlib.protocol.HTTP;
+
+class BasicHttpCache implements HttpCache {
+    private static final Set<String> safeRequestMethods = new HashSet<String>(
+            Arrays.asList(HeaderConstants.HEAD_METHOD,
+                    HeaderConstants.GET_METHOD, HeaderConstants.OPTIONS_METHOD,
+                    HeaderConstants.TRACE_METHOD));
+
+    private final CacheKeyGenerator uriExtractor;
+    private final ResourceFactory resourceFactory;
+    private final long maxObjectSizeBytes;
+    private final CacheEntryUpdater cacheEntryUpdater;
+    private final CachedHttpResponseGenerator responseGenerator;
+    private final HttpCacheInvalidator cacheInvalidator;
+    private final HttpCacheStorage storage;
+
+    public HttpClientAndroidLog log = new HttpClientAndroidLog(getClass());
+
+    public BasicHttpCache(
+            final ResourceFactory resourceFactory,
+            final HttpCacheStorage storage,
+            final CacheConfig config,
+            final CacheKeyGenerator uriExtractor,
+            final HttpCacheInvalidator cacheInvalidator) {
+        this.resourceFactory = resourceFactory;
+        this.uriExtractor = uriExtractor;
+        this.cacheEntryUpdater = new CacheEntryUpdater(resourceFactory);
+        this.maxObjectSizeBytes = config.getMaxObjectSize();
+        this.responseGenerator = new CachedHttpResponseGenerator();
+        this.storage = storage;
+        this.cacheInvalidator = cacheInvalidator;
+    }
+
+    public BasicHttpCache(
+            final ResourceFactory resourceFactory,
+            final HttpCacheStorage storage,
+            final CacheConfig config,
+            final CacheKeyGenerator uriExtractor) {
+        this( resourceFactory, storage, config, uriExtractor,
+                new CacheInvalidator(uriExtractor, storage));
+    }
+
+    public BasicHttpCache(
+            final ResourceFactory resourceFactory,
+            final HttpCacheStorage storage,
+            final CacheConfig config) {
+        this( resourceFactory, storage, config, new CacheKeyGenerator());
+    }
+
+    public BasicHttpCache(final CacheConfig config) {
+        this(new HeapResourceFactory(), new BasicHttpCacheStorage(config), config);
+    }
+
+    public BasicHttpCache() {
+        this(CacheConfig.DEFAULT);
+    }
+
+    public void flushCacheEntriesFor(final HttpHost host, final HttpRequest request)
+            throws IOException {
+        if (!safeRequestMethods.contains(request.getRequestLine().getMethod())) {
+            final String uri = uriExtractor.getURI(host, request);
+            storage.removeEntry(uri);
+        }
+    }
+
+    public void flushInvalidatedCacheEntriesFor(final HttpHost host, final HttpRequest request, final HttpResponse response) {
+        if (!safeRequestMethods.contains(request.getRequestLine().getMethod())) {
+            cacheInvalidator.flushInvalidatedCacheEntries(host, request, response);
+        }
+    }
+
+    void storeInCache(
+            final HttpHost target, final HttpRequest request, final HttpCacheEntry entry) throws IOException {
+        if (entry.hasVariants()) {
+            storeVariantEntry(target, request, entry);
+        } else {
+            storeNonVariantEntry(target, request, entry);
+        }
+    }
+
+    void storeNonVariantEntry(
+            final HttpHost target, final HttpRequest req, final HttpCacheEntry entry) throws IOException {
+        final String uri = uriExtractor.getURI(target, req);
+        storage.putEntry(uri, entry);
+    }
+
+    void storeVariantEntry(
+            final HttpHost target,
+            final HttpRequest req,
+            final HttpCacheEntry entry) throws IOException {
+        final String parentURI = uriExtractor.getURI(target, req);
+        final String variantURI = uriExtractor.getVariantURI(target, req, entry);
+        storage.putEntry(variantURI, entry);
+
+        final HttpCacheUpdateCallback callback = new HttpCacheUpdateCallback() {
+
+            public HttpCacheEntry update(final HttpCacheEntry existing) throws IOException {
+                return doGetUpdatedParentEntry(
+                        req.getRequestLine().getUri(), existing, entry,
+                        uriExtractor.getVariantKey(req, entry),
+                        variantURI);
+            }
+
+        };
+
+        try {
+            storage.updateEntry(parentURI, callback);
+        } catch (final HttpCacheUpdateException e) {
+            log.warn("Could not update key [" + parentURI + "]", e);
+        }
+    }
+
+    public void reuseVariantEntryFor(final HttpHost target, final HttpRequest req,
+            final Variant variant) throws IOException {
+        final String parentCacheKey = uriExtractor.getURI(target, req);
+        final HttpCacheEntry entry = variant.getEntry();
+        final String variantKey = uriExtractor.getVariantKey(req, entry);
+        final String variantCacheKey = variant.getCacheKey();
+
+        final HttpCacheUpdateCallback callback = new HttpCacheUpdateCallback() {
+            public HttpCacheEntry update(final HttpCacheEntry existing)
+                    throws IOException {
+                return doGetUpdatedParentEntry(req.getRequestLine().getUri(),
+                        existing, entry, variantKey, variantCacheKey);
+            }
+        };
+
+        try {
+            storage.updateEntry(parentCacheKey, callback);
+        } catch (final HttpCacheUpdateException e) {
+            log.warn("Could not update key [" + parentCacheKey + "]", e);
+        }
+    }
+
+    boolean isIncompleteResponse(final HttpResponse resp, final Resource resource) {
+        final int status = resp.getStatusLine().getStatusCode();
+        if (status != HttpStatus.SC_OK
+            && status != HttpStatus.SC_PARTIAL_CONTENT) {
+            return false;
+        }
+        final Header hdr = resp.getFirstHeader(HTTP.CONTENT_LEN);
+        if (hdr == null) {
+            return false;
+        }
+        final int contentLength;
+        try {
+            contentLength = Integer.parseInt(hdr.getValue());
+        } catch (final NumberFormatException nfe) {
+            return false;
+        }
+        return (resource.length() < contentLength);
+    }
+
+    CloseableHttpResponse generateIncompleteResponseError(
+            final HttpResponse response, final Resource resource) {
+        final int contentLength = Integer.parseInt(response.getFirstHeader(HTTP.CONTENT_LEN).getValue());
+        final HttpResponse error =
+            new BasicHttpResponse(HttpVersion.HTTP_1_1, HttpStatus.SC_BAD_GATEWAY, "Bad Gateway");
+        error.setHeader("Content-Type","text/plain;charset=UTF-8");
+        final String msg = String.format("Received incomplete response " +
+                "with Content-Length %d but actual body length %d",
+                contentLength, resource.length());
+        final byte[] msgBytes = msg.getBytes();
+        error.setHeader("Content-Length", Integer.toString(msgBytes.length));
+        error.setEntity(new ByteArrayEntity(msgBytes));
+        return Proxies.enhanceResponse(error);
+    }
+
+    HttpCacheEntry doGetUpdatedParentEntry(
+            final String requestId,
+            final HttpCacheEntry existing,
+            final HttpCacheEntry entry,
+            final String variantKey,
+            final String variantCacheKey) throws IOException {
+        HttpCacheEntry src = existing;
+        if (src == null) {
+            src = entry;
+        }
+
+        Resource resource = null;
+        if (src.getResource() != null) {
+            resource = resourceFactory.copy(requestId, src.getResource());
+        }
+        final Map<String,String> variantMap = new HashMap<String,String>(src.getVariantMap());
+        variantMap.put(variantKey, variantCacheKey);
+        return new HttpCacheEntry(
+                src.getRequestDate(),
+                src.getResponseDate(),
+                src.getStatusLine(),
+                src.getAllHeaders(),
+                resource,
+                variantMap);
+    }
+
+    public HttpCacheEntry updateCacheEntry(final HttpHost target, final HttpRequest request,
+            final HttpCacheEntry stale, final HttpResponse originResponse,
+            final Date requestSent, final Date responseReceived) throws IOException {
+        final HttpCacheEntry updatedEntry = cacheEntryUpdater.updateCacheEntry(
+                request.getRequestLine().getUri(),
+                stale,
+                requestSent,
+                responseReceived,
+                originResponse);
+        storeInCache(target, request, updatedEntry);
+        return updatedEntry;
+    }
+
+    public HttpCacheEntry updateVariantCacheEntry(final HttpHost target, final HttpRequest request,
+            final HttpCacheEntry stale, final HttpResponse originResponse,
+            final Date requestSent, final Date responseReceived, final String cacheKey) throws IOException {
+        final HttpCacheEntry updatedEntry = cacheEntryUpdater.updateCacheEntry(
+                request.getRequestLine().getUri(),
+                stale,
+                requestSent,
+                responseReceived,
+                originResponse);
+        storage.putEntry(cacheKey, updatedEntry);
+        return updatedEntry;
+    }
+
+    public HttpResponse cacheAndReturnResponse(final HttpHost host, final HttpRequest request,
+            final HttpResponse originResponse, final Date requestSent, final Date responseReceived)
+            throws IOException {
+        return cacheAndReturnResponse(host, request,
+                Proxies.enhanceResponse(originResponse), requestSent,
+                responseReceived);
+    }
+
+    public CloseableHttpResponse cacheAndReturnResponse(
+            final HttpHost host,
+            final HttpRequest request,
+            final CloseableHttpResponse originResponse,
+            final Date requestSent,
+            final Date responseReceived) throws IOException {
+
+        boolean closeOriginResponse = true;
+        final SizeLimitedResponseReader responseReader = getResponseReader(request, originResponse);
+        try {
+            responseReader.readResponse();
+
+            if (responseReader.isLimitReached()) {
+                closeOriginResponse = false;
+                return responseReader.getReconstructedResponse();
+            }
+
+            final Resource resource = responseReader.getResource();
+            if (isIncompleteResponse(originResponse, resource)) {
+                return generateIncompleteResponseError(originResponse, resource);
+            }
+
+            final HttpCacheEntry entry = new HttpCacheEntry(
+                    requestSent,
+                    responseReceived,
+                    originResponse.getStatusLine(),
+                    originResponse.getAllHeaders(),
+                    resource);
+            storeInCache(host, request, entry);
+            return responseGenerator.generateResponse(entry);
+        } finally {
+            if (closeOriginResponse) {
+                originResponse.close();
+            }
+        }
+    }
+
+    SizeLimitedResponseReader getResponseReader(final HttpRequest request,
+            final CloseableHttpResponse backEndResponse) {
+        return new SizeLimitedResponseReader(
+                resourceFactory, maxObjectSizeBytes, request, backEndResponse);
+    }
+
+    public HttpCacheEntry getCacheEntry(final HttpHost host, final HttpRequest request) throws IOException {
+        final HttpCacheEntry root = storage.getEntry(uriExtractor.getURI(host, request));
+        if (root == null) {
+            return null;
+        }
+        if (!root.hasVariants()) {
+            return root;
+        }
+        final String variantCacheKey = root.getVariantMap().get(uriExtractor.getVariantKey(request, root));
+        if (variantCacheKey == null) {
+            return null;
+        }
+        return storage.getEntry(variantCacheKey);
+    }
+
+    public void flushInvalidatedCacheEntriesFor(final HttpHost host,
+            final HttpRequest request) throws IOException {
+        cacheInvalidator.flushInvalidatedCacheEntries(host, request);
+    }
+
+    public Map<String, Variant> getVariantCacheEntriesWithEtags(final HttpHost host, final HttpRequest request)
+            throws IOException {
+        final Map<String,Variant> variants = new HashMap<String,Variant>();
+        final HttpCacheEntry root = storage.getEntry(uriExtractor.getURI(host, request));
+        if (root == null || !root.hasVariants()) {
+            return variants;
+        }
+        for(final Map.Entry<String, String> variant : root.getVariantMap().entrySet()) {
+            final String variantKey = variant.getKey();
+            final String variantCacheKey = variant.getValue();
+            addVariantWithEtag(variantKey, variantCacheKey, variants);
+        }
+        return variants;
+    }
+
+    private void addVariantWithEtag(final String variantKey,
+            final String variantCacheKey, final Map<String, Variant> variants)
+            throws IOException {
+        final HttpCacheEntry entry = storage.getEntry(variantCacheKey);
+        if (entry == null) {
+            return;
+        }
+        final Header etagHeader = entry.getFirstHeader(HeaderConstants.ETAG);
+        if (etagHeader == null) {
+            return;
+        }
+        variants.put(etagHeader.getValue(), new Variant(variantKey, variantCacheKey, entry));
+    }
+
+}