Bug 428916 - support Cache-control directives in HTTP requests, r=mcmanus+michal+froydnj

This commit is contained in:
Honza Bambas 2016-05-20 08:33:00 +02:00
parent b5b5c03685
commit 97f671937b
8 changed files with 615 additions and 12 deletions

View File

@ -0,0 +1,123 @@
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set sw=2 ts=8 et tw=80 : */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#include "CacheControlParser.h"
namespace mozilla {
namespace net {
CacheControlParser::CacheControlParser(nsACString const &aHeader)
: Tokenizer(aHeader, nullptr, "-_")
, mMaxAgeSet(false)
, mMaxAge(0)
, mMaxStaleSet(false)
, mMaxStale(0)
, mMinFreshSet(false)
, mMinFresh(0)
, mNoCache(false)
, mNoStore(false)
{
SkipWhites();
if (!CheckEOF()) {
Directive();
}
}
void CacheControlParser::Directive()
{
if (CheckWord("no-cache")) {
mNoCache = true;
IgnoreDirective(); // ignore any optionally added values
} else if (CheckWord("no-store")) {
mNoStore = true;
} else if (CheckWord("max-age")) {
mMaxAgeSet = SecondsValue(&mMaxAge);
} else if (CheckWord("max-stale")) {
mMaxStaleSet = SecondsValue(&mMaxStale, PR_UINT32_MAX);
} else if (CheckWord("min-fresh")) {
mMinFreshSet = SecondsValue(&mMinFresh);
} else {
IgnoreDirective();
}
SkipWhites();
if (CheckEOF()) {
return;
}
if (CheckChar(',')) {
SkipWhites();
Directive();
return;
}
NS_WARNING("Unexpected input in Cache-control header value");
}
bool CacheControlParser::SecondsValue(uint32_t *seconds, uint32_t defaultVal)
{
SkipWhites();
if (!CheckChar('=')) {
*seconds = defaultVal;
return !!defaultVal;
}
SkipWhites();
if (!ReadInteger(seconds)) {
NS_WARNING("Unexpected value in Cache-control header value");
return false;
}
return true;
}
void CacheControlParser::IgnoreDirective()
{
Token t;
while (Next(t)) {
if (t.Equals(Token::Char(',')) || t.Equals(Token::EndOfFile())) {
Rollback();
break;
}
if (t.Equals(Token::Char('"'))) {
SkipUntil(Token::Char('"'));
if (!CheckChar('"')) {
NS_WARNING("Missing quoted string expansion in Cache-control header value");
break;
}
}
}
}
bool CacheControlParser::MaxAge(uint32_t *seconds)
{
*seconds = mMaxAge;
return mMaxAgeSet;
}
bool CacheControlParser::MaxStale(uint32_t *seconds)
{
*seconds = mMaxStale;
return mMaxStaleSet;
}
bool CacheControlParser::MinFresh(uint32_t *seconds)
{
*seconds = mMinFresh;
return mMinFreshSet;
}
bool CacheControlParser::NoCache()
{
return mNoCache;
}
bool CacheControlParser::NoStore()
{
return mNoStore;
}
} // net
} // mozilla

View File

@ -0,0 +1,44 @@
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set sw=2 ts=8 et tw=80 : */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#ifndef CacheControlParser_h__
#define CacheControlParser_h__
#include "mozilla/Tokenizer.h"
namespace mozilla {
namespace net {
class CacheControlParser final : Tokenizer
{
public:
explicit CacheControlParser(nsACString const &header);
bool MaxAge(uint32_t *seconds);
bool MaxStale(uint32_t *seconds);
bool MinFresh(uint32_t *seconds);
bool NoCache();
bool NoStore();
private:
void Directive();
void IgnoreDirective();
bool SecondsValue(uint32_t *seconds, uint32_t defaultVal = 0);
bool mMaxAgeSet;
uint32_t mMaxAge;
bool mMaxStaleSet;
uint32_t mMaxStale;
bool mMinFreshSet;
uint32_t mMinFresh;
bool mNoCache;
bool mNoStore;
};
} // net
} // mozilla
#endif

View File

@ -52,6 +52,7 @@ SOURCES += [
]
UNIFIED_SOURCES += [
'CacheControlParser.cpp',
'ConnectionDiagnostics.cpp',
'Http2Compression.cpp',
'Http2Push.cpp',

View File

@ -95,6 +95,7 @@
#include "nsCORSListenerProxy.h"
#include "nsISocketProvider.h"
#include "mozilla/net/Predictor.h"
#include "CacheControlParser.h"
namespace mozilla { namespace net {
@ -3146,6 +3147,14 @@ nsHttpChannel::OpenCacheEntry(bool isHttps)
uint32_t cacheEntryOpenFlags;
bool offline = gIOService->IsOffline() || appOffline;
nsAutoCString cacheControlRequestHeader;
mRequestHead.GetHeader(nsHttp::Cache_Control, cacheControlRequestHeader);
CacheControlParser cacheControlRequest(cacheControlRequestHeader);
if (cacheControlRequest.NoStore() && !PossiblyIntercepted()) {
goto bypassCacheEntryOpen;
}
if (offline || (mLoadFlags & INHIBIT_CACHING)) {
if (BYPASS_LOCAL_CACHE(mLoadFlags) && !offline && !PossiblyIntercepted()) {
goto bypassCacheEntryOpen;
@ -3314,6 +3323,16 @@ nsHttpChannel::OnCacheEntryCheck(nsICacheEntry* entry, nsIApplicationCache* appC
LOG(("nsHttpChannel::OnCacheEntryCheck enter [channel=%p entry=%p]",
this, entry));
nsAutoCString cacheControlRequestHeader;
mRequestHead.GetHeader(nsHttp::Cache_Control, cacheControlRequestHeader);
CacheControlParser cacheControlRequest(cacheControlRequestHeader);
if (cacheControlRequest.NoStore()) {
LOG(("Not using cached response based on no-store request cache directive\n"));
*aResult = ENTRY_NOT_WANTED;
return NS_OK;
}
// Remember the request is a custom conditional request so that we can
// process any 304 response correctly.
mCustomConditionalRequest =
@ -3522,26 +3541,52 @@ nsHttpChannel::OnCacheEntryCheck(nsICacheEntry* entry, nsIApplicationCache* appC
// and didn't do heuristic on it. but defacto that is allowed now.
//
// Check if the cache entry has expired...
uint32_t time = 0; // a temporary variable for storing time values...
rv = entry->GetExpirationTime(&time);
uint32_t now = NowInSeconds();
uint32_t age = 0;
rv = mCachedResponseHead->ComputeCurrentAge(now, now, &age);
NS_ENSURE_SUCCESS(rv, rv);
LOG((" NowInSeconds()=%u, time=%u", NowInSeconds(), time));
if (NowInSeconds() <= time)
doValidation = false;
else if (mCachedResponseHead->MustValidateIfExpired())
uint32_t freshness = 0;
rv = mCachedResponseHead->ComputeFreshnessLifetime(&freshness);
NS_ENSURE_SUCCESS(rv, rv);
uint32_t expiration = 0;
rv = entry->GetExpirationTime(&expiration);
NS_ENSURE_SUCCESS(rv, rv);
uint32_t maxAgeRequest, maxStaleRequest, minFreshRequest;
LOG((" NowInSeconds()=%u, expiration time=%u, freshness lifetime=%u, age=%u",
now, expiration, freshness, age));
if (cacheControlRequest.NoCache()) {
LOG((" validating, no-cache request"));
doValidation = true;
else if (mLoadFlags & nsIRequest::VALIDATE_ONCE_PER_SESSION) {
} else if (cacheControlRequest.MaxStale(&maxStaleRequest)) {
uint32_t staleTime = age > freshness ? age - freshness : 0;
doValidation = staleTime > maxStaleRequest;
LOG((" validating=%d, max-stale=%u requested", doValidation, maxStaleRequest));
} else if (cacheControlRequest.MaxAge(&maxAgeRequest)) {
doValidation = age > maxAgeRequest;
LOG((" validating=%d, max-age=%u requested", doValidation, maxAgeRequest));
} else if (cacheControlRequest.MinFresh(&minFreshRequest)) {
uint32_t freshTime = freshness > age ? freshness - age : 0;
doValidation = freshTime < minFreshRequest;
LOG((" validating=%d, min-fresh=%u requested", doValidation, minFreshRequest));
} else if (now <= expiration) {
doValidation = false;
LOG((" not validating, expire time not in the past"));
} else if (mCachedResponseHead->MustValidateIfExpired()) {
doValidation = true;
} else if (mLoadFlags & nsIRequest::VALIDATE_ONCE_PER_SESSION) {
// If the cached response does not include expiration infor-
// mation, then we must validate the response, despite whether
// or not this is the first access this session. This behavior
// is consistent with existing browsers and is generally expected
// by web authors.
rv = mCachedResponseHead->ComputeFreshnessLifetime(&time);
NS_ENSURE_SUCCESS(rv, rv);
if (time == 0)
if (freshness == 0)
doValidation = true;
else
doValidation = fromPreviousSession;

View File

@ -10,6 +10,7 @@
#include "nsHttpHeaderArray.h"
#include "nsURLHelper.h"
#include "nsIHttpHeaderVisitor.h"
#include "nsHttpHandler.h"
namespace mozilla {
namespace net {

View File

@ -410,6 +410,16 @@ function MultipleCallbacks(number, goon, delayed)
this.delayed = delayed;
}
function wait_for_cache_index(continue_func)
{
// This callback will not fire before the index is in the ready state. nsICacheStorage.exists() will
// no longer throw after this point.
get_cache_service().asyncGetDiskConsumption({
onNetworkCacheDiskConsumption: function() { continue_func(); },
QueryInterface() { return this; }
});
}
function finish_cache2_test()
{
callbacks.forEach(function(callback, index) {

View File

@ -0,0 +1,379 @@
Cu.import("resource://testing-common/httpd.js");
Cu.import("resource://gre/modules/NetUtil.jsm");
var httpserver = new HttpServer();
httpserver.start(-1);
var cache = null;
var base_url = "http://localhost:" + httpserver.identity.primaryPort;
var resource_age_100 = "/resource_age_100";
var resource_age_100_url = base_url + resource_age_100;
var resource_stale_100 = "/resource_stale_100";
var resource_stale_100_url = base_url + resource_stale_100;
var resource_fresh_100 = "/resource_fresh_100";
var resource_fresh_100_url = base_url + resource_fresh_100;
// Test flags
var hit_server = false;
function make_channel(url, cache_control)
{
// Reset test global status
hit_server = false;
var req = NetUtil.newChannel({uri: url, loadUsingSystemPrincipal: true});
req.QueryInterface(Ci.nsIHttpChannel);
if (cache_control) {
req.setRequestHeader("Cache-control", cache_control, false);
}
return req;
}
function make_uri(url) {
var ios = Cc["@mozilla.org/network/io-service;1"].
getService(Ci.nsIIOService);
return ios.newURI(url, null, null);
}
function resource_age_100_handler(metadata, response)
{
hit_server = true;
response.setStatusLine(metadata.httpVersion, 200, "OK");
response.setHeader("Content-Type", "text/plain", false);
response.setHeader("Age", "100", false);
response.setHeader("Last-Modified", date_string_from_now(-100), false);
response.setHeader("Expires", date_string_from_now(+9999), false);
const body = "data1";
response.bodyOutputStream.write(body, body.length);
}
function resource_stale_100_handler(metadata, response)
{
hit_server = true;
response.setStatusLine(metadata.httpVersion, 200, "OK");
response.setHeader("Content-Type", "text/plain", false);
response.setHeader("Date", date_string_from_now(-200), false);
response.setHeader("Last-Modified", date_string_from_now(-200), false);
response.setHeader("Cache-Control", "max-age=100", false);
response.setHeader("Expires", date_string_from_now(-100), false);
const body = "data2";
response.bodyOutputStream.write(body, body.length);
}
function resource_fresh_100_handler(metadata, response)
{
hit_server = true;
response.setStatusLine(metadata.httpVersion, 200, "OK");
response.setHeader("Content-Type", "text/plain", false);
response.setHeader("Last-Modified", date_string_from_now(0), false);
response.setHeader("Cache-Control", "max-age=100", false);
response.setHeader("Expires", date_string_from_now(+100), false);
const body = "data3";
response.bodyOutputStream.write(body, body.length);
}
function run_test()
{
do_get_profile();
do_test_pending();
httpserver.registerPathHandler(resource_age_100, resource_age_100_handler);
httpserver.registerPathHandler(resource_stale_100, resource_stale_100_handler);
httpserver.registerPathHandler(resource_fresh_100, resource_fresh_100_handler);
cache = getCacheStorage("disk");
wait_for_cache_index(run_next_test);
}
// Here starts the list of tests
// ============================================================================
// Cache-Control: no-store
add_test(() => {
// Must not create a cache entry
var ch = make_channel(resource_age_100_url, "no-store");
ch.asyncOpen(new ChannelListener(function(request, data) {
do_check_true(hit_server);
do_check_false(cache.exists(make_uri(resource_age_100_url), ""));
run_next_test();
}, null), null);
});
add_test(() => {
// Prepare state only, cache the entry
var ch = make_channel(resource_age_100_url);
ch.asyncOpen(new ChannelListener(function(request, data) {
do_check_true(hit_server);
do_check_true(cache.exists(make_uri(resource_age_100_url), ""));
run_next_test();
}, null), null);
});
add_test(() => {
// Check the prepared cache entry is used when no special directives are added
var ch = make_channel(resource_age_100_url);
ch.asyncOpen(new ChannelListener(function(request, data) {
do_check_false(hit_server);
do_check_true(cache.exists(make_uri(resource_age_100_url), ""));
run_next_test();
}, null), null);
});
add_test(() => {
// Try again, while we already keep a cache entry,
// the channel must not use it, entry should stay in the cache
var ch = make_channel(resource_age_100_url, "no-store");
ch.asyncOpen(new ChannelListener(function(request, data) {
do_check_true(hit_server);
do_check_true(cache.exists(make_uri(resource_age_100_url), ""));
run_next_test();
}, null), null);
});
// ============================================================================
// Cache-Control: no-cache
add_test(() => {
// Check the prepared cache entry is used when no special directives are added
var ch = make_channel(resource_age_100_url);
ch.asyncOpen(new ChannelListener(function(request, data) {
do_check_false(hit_server);
do_check_true(cache.exists(make_uri(resource_age_100_url), ""));
run_next_test();
}, null), null);
});
add_test(() => {
// The existing entry should be revalidated (we expect a server hit)
var ch = make_channel(resource_age_100_url, "no-cache");
ch.asyncOpen(new ChannelListener(function(request, data) {
do_check_true(hit_server);
do_check_true(cache.exists(make_uri(resource_age_100_url), ""));
run_next_test();
}, null), null);
});
// ============================================================================
// Cache-Control: max-age
add_test(() => {
// Check the prepared cache entry is used when no special directives are added
var ch = make_channel(resource_age_100_url);
ch.asyncOpen(new ChannelListener(function(request, data) {
do_check_false(hit_server);
do_check_true(cache.exists(make_uri(resource_age_100_url), ""));
run_next_test();
}, null), null);
});
add_test(() => {
// The existing entry's age is greater than the maximum requested,
// should hit server
var ch = make_channel(resource_age_100_url, "max-age=10");
ch.asyncOpen(new ChannelListener(function(request, data) {
do_check_true(hit_server);
do_check_true(cache.exists(make_uri(resource_age_100_url), ""));
run_next_test();
}, null), null);
});
add_test(() => {
// The existing entry's age is greater than the maximum requested,
// but the max-stale directive says to use it when it's fresh enough
var ch = make_channel(resource_age_100_url, "max-age=10, max-stale=99999");
ch.asyncOpen(new ChannelListener(function(request, data) {
do_check_false(hit_server);
do_check_true(cache.exists(make_uri(resource_age_100_url), ""));
run_next_test();
}, null), null);
});
add_test(() => {
// The existing entry's age is lesser than the maximum requested,
// should go from cache
var ch = make_channel(resource_age_100_url, "max-age=1000");
ch.asyncOpen(new ChannelListener(function(request, data) {
do_check_false(hit_server);
do_check_true(cache.exists(make_uri(resource_age_100_url), ""));
run_next_test();
}, null), null);
});
// ============================================================================
// Cache-Control: max-stale
add_test(() => {
// Preprate the entry first
var ch = make_channel(resource_stale_100_url);
ch.asyncOpen(new ChannelListener(function(request, data) {
do_check_true(hit_server);
do_check_true(cache.exists(make_uri(resource_stale_100_url), ""));
// Must shift the expiration time set on the entry to |now| be in the past
do_timeout(1500, run_next_test);
}, null), null);
});
add_test(() => {
// Check it's not reused (as it's stale) when no special directives
// are provided
var ch = make_channel(resource_stale_100_url);
ch.asyncOpen(new ChannelListener(function(request, data) {
do_check_true(hit_server);
do_check_true(cache.exists(make_uri(resource_stale_100_url), ""));
do_timeout(1500, run_next_test);
}, null), null);
});
add_test(() => {
// Accept cached responses of any stale time
var ch = make_channel(resource_stale_100_url, "max-stale");
ch.asyncOpen(new ChannelListener(function(request, data) {
do_check_false(hit_server);
do_check_true(cache.exists(make_uri(resource_stale_100_url), ""));
do_timeout(1500, run_next_test);
}, null), null);
});
add_test(() => {
// The entry is stale only by 100 seconds, accept it
var ch = make_channel(resource_stale_100_url, "max-stale=1000");
ch.asyncOpen(new ChannelListener(function(request, data) {
do_check_false(hit_server);
do_check_true(cache.exists(make_uri(resource_stale_100_url), ""));
do_timeout(1500, run_next_test);
}, null), null);
});
add_test(() => {
// The entry is stale by 100 seconds but we only accept a 10 seconds stale
// entry, go from server
var ch = make_channel(resource_stale_100_url, "max-stale=10");
ch.asyncOpen(new ChannelListener(function(request, data) {
do_check_true(hit_server);
do_check_true(cache.exists(make_uri(resource_stale_100_url), ""));
run_next_test();
}, null), null);
});
// ============================================================================
// Cache-Control: min-fresh
add_test(() => {
// Preprate the entry first
var ch = make_channel(resource_fresh_100_url);
ch.asyncOpen(new ChannelListener(function(request, data) {
do_check_true(hit_server);
do_check_true(cache.exists(make_uri(resource_fresh_100_url), ""));
run_next_test();
}, null), null);
});
add_test(() => {
// Check it's reused when no special directives are provided
var ch = make_channel(resource_fresh_100_url);
ch.asyncOpen(new ChannelListener(function(request, data) {
do_check_false(hit_server);
do_check_true(cache.exists(make_uri(resource_fresh_100_url), ""));
run_next_test();
}, null), null);
});
add_test(() => {
// Entry fresh enough to be served from the cache
var ch = make_channel(resource_fresh_100_url, "min-fresh=10");
ch.asyncOpen(new ChannelListener(function(request, data) {
do_check_false(hit_server);
do_check_true(cache.exists(make_uri(resource_fresh_100_url), ""));
run_next_test();
}, null), null);
});
add_test(() => {
// The entry is not fresh enough
var ch = make_channel(resource_fresh_100_url, "min-fresh=1000");
ch.asyncOpen(new ChannelListener(function(request, data) {
do_check_true(hit_server);
do_check_true(cache.exists(make_uri(resource_fresh_100_url), ""));
run_next_test();
}, null), null);
});
// ============================================================================
// Parser test, if the Cache-Control header would not parse correctly, the entry
// doesn't load from the server.
add_test(() => {
var ch = make_channel(resource_fresh_100_url, "unknown1,unknown2 = \"a,b\", min-fresh = 1000 ");
ch.asyncOpen(new ChannelListener(function(request, data) {
do_check_true(hit_server);
do_check_true(cache.exists(make_uri(resource_fresh_100_url), ""));
run_next_test();
}, null), null);
});
add_test(() => {
var ch = make_channel(resource_fresh_100_url, "no-cache = , min-fresh = 10");
ch.asyncOpen(new ChannelListener(function(request, data) {
do_check_true(hit_server);
do_check_true(cache.exists(make_uri(resource_fresh_100_url), ""));
run_next_test();
}, null), null);
});
// ============================================================================
// Done
add_test(() => {
run_next_test();
httpserver.stop(do_test_finished);
});
// ============================================================================
// Helpers
function date_string_from_now(delta_secs) {
var months = ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug',
'Sep', 'Oct', 'Nov', 'Dec'];
var days = ['Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat'];
var d = new Date();
d.setTime(d.getTime() + delta_secs * 1000);
return days[d.getUTCDay()] + ", " +
d.getUTCDate() + " " +
months[d.getUTCMonth()] + " " +
d.getUTCFullYear() + " " +
d.getUTCHours() + ":" +
d.getUTCMinutes() + ":" +
d.getUTCSeconds() + " UTC";
}

View File

@ -356,4 +356,4 @@ skip-if = os == "android"
[test_packaged_app_bug1214079.js]
[test_bug412457.js]
[test_bug464591.js]
[test_cache-control_request.js]