mozilla
/
gecko-dev
зеркало из https://github.com/mozilla/gecko-dev.git
1
0
Форкнуть 0
Код Задачи Пакеты Проекты Релизы Вики Активность
gecko-dev/dom/cache/DBSchema.cpp

3544 строки
116 KiB
C++
Исходник Ответственный История

/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 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 "mozilla/dom/cache/DBSchema.h"
#include "ipc/IPCMessageUtils.h"
#include "mozilla/BasePrincipal.h"
#include "mozilla/dom/HeadersBinding.h"
#include "mozilla/dom/InternalHeaders.h"
#include "mozilla/dom/InternalResponse.h"
#include "mozilla/dom/RequestBinding.h"
#include "mozilla/dom/ResponseBinding.h"
#include "mozilla/dom/cache/CacheCommon.h"
#include "mozilla/dom/cache/CacheTypes.h"
#include "mozilla/dom/cache/SavedTypes.h"
#include "mozilla/dom/cache/Types.h"
#include "mozilla/dom/cache/TypeUtils.h"
#include "mozilla/net/MozURL.h"
#include "mozilla/ResultExtensions.h"
#include "mozilla/StaticPrefs_extensions.h"
#include "mozIStorageConnection.h"
#include "mozIStorageStatement.h"
#include "mozStorageHelper.h"
#include "nsCOMPtr.h"
#include "nsCRT.h"
#include "nsHttp.h"
#include "nsIContentPolicy.h"
#include "nsICryptoHash.h"
#include "nsNetCID.h"
#include "nsPrintfCString.h"
#include "nsTArray.h"
namespace mozilla {
namespace dom {
namespace cache {
namespace db {
const int32_t kFirstShippedSchemaVersion = 15;
namespace {
// ## Firefox 57 Cache API v25/v26/v27 Schema Hack Info
// ### Overview
// In Firefox 57 we introduced Cache API schema version 26 and Quota Manager
// schema v3 to support tracking padding for opaque responses. Unfortunately,
// Firefox 57 is a big release that may potentially result in users downgrading
// to Firefox 56 due to 57 retiring add-ons. These schema changes have the
// unfortunate side-effect of causing QuotaManager and all its clients to break
// if the user downgrades to 56. In order to avoid making a bad situation
// worse, we're now retrofitting 57 so that Firefox 56 won't freak out.
//
// ### Implementation
// We're introducing a new schema version 27 that uses an on-disk schema version
// of v25. We differentiate v25 from v27 by the presence of the column added
// by v26. This translates to:
// - v25: on-disk schema=25, no "response_padding_size" column in table
// "entries".
// - v26: on-disk schema=26, yes "response_padding_size" column in table
// "entries".
// - v27: on-disk schema=25, yes "response_padding_size" column in table
// "entries".
//
// ### Fallout
// Firefox 57 is happy because it sees schema 27 and everything is as it
// expects.
//
// Firefox 56 non-DEBUG build is fine/happy, but DEBUG builds will not be.
// - Our QuotaClient will invoke `NS_WARNING("Unknown Cache file found!");`
// at QuotaManager init time. This is harmless but annoying and potentially
// misleading.
// - The DEBUG-only Validate() call will error out whenever an attempt is made
// to open a DOM Cache database because it will notice the schema is broken
// and there is no attempt at recovery.
//
const int32_t kHackyDowngradeSchemaVersion = 25;
const int32_t kHackyPaddingSizePresentVersion = 27;
//
// Update this whenever the DB schema is changed.
const int32_t kLatestSchemaVersion = 27;
// ---------
// The following constants define the SQL schema. These are defined in the
// same order the SQL should be executed in CreateOrMigrateSchema(). They are
// broken out as constants for convenient use in validation and migration.
// ---------
// The caches table is the single source of truth about what Cache
// objects exist for the origin. The contents of the Cache are stored
// in the entries table that references back to caches.
//
// The caches table is also referenced from storage. Rows in storage
// represent named Cache objects. There are cases, however, where
// a Cache can still exist, but not be in a named Storage. For example,
// when content is still using the Cache after CacheStorage::Delete()
// has been run.
//
// For now, the caches table mainly exists for data integrity with
// foreign keys, but could be expanded to contain additional cache object
// information.
//
// AUTOINCREMENT is necessary to prevent CacheId values from being reused.
const char* const kTableCaches =
"CREATE TABLE caches ("
"id INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT "
")";
// Security blobs are quite large and duplicated for every Response from
// the same https origin. This table is used to de-duplicate this data.
const char* const kTableSecurityInfo =
"CREATE TABLE security_info ("
"id INTEGER NOT NULL PRIMARY KEY, "
"hash BLOB NOT NULL, " // first 8-bytes of the sha1 hash of data column
"data BLOB NOT NULL, " // full security info data, usually a few KB
"refcount INTEGER NOT NULL"
")";
// Index the smaller hash value instead of the large security data blob.
const char* const kIndexSecurityInfoHash =
"CREATE INDEX security_info_hash_index ON security_info (hash)";
const char* const kTableEntries =
"CREATE TABLE entries ("
"id INTEGER NOT NULL PRIMARY KEY, "
"request_method TEXT NOT NULL, "
"request_url_no_query TEXT NOT NULL, "
"request_url_no_query_hash BLOB NOT NULL, " // first 8-bytes of sha1 hash
"request_url_query TEXT NOT NULL, "
"request_url_query_hash BLOB NOT NULL, " // first 8-bytes of sha1 hash
"request_referrer TEXT NOT NULL, "
"request_headers_guard INTEGER NOT NULL, "
"request_mode INTEGER NOT NULL, "
"request_credentials INTEGER NOT NULL, "
"request_contentpolicytype INTEGER NOT NULL, "
"request_cache INTEGER NOT NULL, "
"request_body_id TEXT NULL, "
"response_type INTEGER NOT NULL, "
"response_status INTEGER NOT NULL, "
"response_status_text TEXT NOT NULL, "
"response_headers_guard INTEGER NOT NULL, "
"response_body_id TEXT NULL, "
"response_security_info_id INTEGER NULL REFERENCES security_info(id), "
"response_principal_info TEXT NOT NULL, "
"cache_id INTEGER NOT NULL REFERENCES caches(id) ON DELETE CASCADE, "
"request_redirect INTEGER NOT NULL, "
"request_referrer_policy INTEGER NOT NULL, "
"request_integrity TEXT NOT NULL, "
"request_url_fragment TEXT NOT NULL, "
"response_padding_size INTEGER NULL "
// New columns must be added at the end of table to migrate and
// validate properly.
")";
// Create an index to support the QueryCache() matching algorithm. This
// needs to quickly find entries in a given Cache that match the request
// URL. The url query is separated in order to support the ignoreSearch
// option. Finally, we index hashes of the URL values instead of the
// actual strings to avoid excessive disk bloat. The index will duplicate
// the contents of the columsn in the index. The hash index will prune
// the vast majority of values from the query result so that normal
// scanning only has to be done on a few values to find an exact URL match.
const char* const kIndexEntriesRequest =
"CREATE INDEX entries_request_match_index "
"ON entries (cache_id, request_url_no_query_hash, "
"request_url_query_hash)";
const char* const kTableRequestHeaders =
"CREATE TABLE request_headers ("
"name TEXT NOT NULL, "
"value TEXT NOT NULL, "
"entry_id INTEGER NOT NULL REFERENCES entries(id) ON DELETE CASCADE"
")";
const char* const kTableResponseHeaders =
"CREATE TABLE response_headers ("
"name TEXT NOT NULL, "
"value TEXT NOT NULL, "
"entry_id INTEGER NOT NULL REFERENCES entries(id) ON DELETE CASCADE"
")";
// We need an index on response_headers, but not on request_headers,
// because we quickly need to determine if a VARY header is present.
const char* const kIndexResponseHeadersName =
"CREATE INDEX response_headers_name_index "
"ON response_headers (name)";
const char* const kTableResponseUrlList =
"CREATE TABLE response_url_list ("
"url TEXT NOT NULL, "
"entry_id INTEGER NOT NULL REFERENCES entries(id) ON DELETE CASCADE"
")";
// NOTE: key allows NULL below since that is how "" is represented
// in a BLOB column. We use BLOB to avoid encoding issues
// with storing DOMStrings.
const char* const kTableStorage =
"CREATE TABLE storage ("
"namespace INTEGER NOT NULL, "
"key BLOB NULL, "
"cache_id INTEGER NOT NULL REFERENCES caches(id), "
"PRIMARY KEY(namespace, key) "
")";
// ---------
// End schema definition
// ---------
const int32_t kMaxEntriesPerStatement = 255;
const uint32_t kPageSize = 4 * 1024;
// Grow the database in chunks to reduce fragmentation
const uint32_t kGrowthSize = 32 * 1024;
const uint32_t kGrowthPages = kGrowthSize / kPageSize;
static_assert(kGrowthSize % kPageSize == 0,
"Growth size must be multiple of page size");
// Only release free pages when we have more than this limit
const int32_t kMaxFreePages = kGrowthPages;
// Limit WAL journal to a reasonable size
const uint32_t kWalAutoCheckpointSize = 512 * 1024;
const uint32_t kWalAutoCheckpointPages = kWalAutoCheckpointSize / kPageSize;
static_assert(kWalAutoCheckpointSize % kPageSize == 0,
"WAL checkpoint size must be multiple of page size");
} // namespace
// If any of the static_asserts below fail, it means that you have changed
// the corresponding WebIDL enum in a way that may be incompatible with the
// existing data stored in the DOM Cache. You would need to update the Cache
// database schema accordingly and adjust the failing static_assert.
static_assert(int(HeadersGuardEnum::None) == 0 &&
int(HeadersGuardEnum::Request) == 1 &&
int(HeadersGuardEnum::Request_no_cors) == 2 &&
int(HeadersGuardEnum::Response) == 3 &&
int(HeadersGuardEnum::Immutable) == 4 &&
HeadersGuardEnumValues::Count == 5,
"HeadersGuardEnum values are as expected");
static_assert(int(ReferrerPolicy::_empty) == 0 &&
int(ReferrerPolicy::No_referrer) == 1 &&
int(ReferrerPolicy::No_referrer_when_downgrade) == 2 &&
int(ReferrerPolicy::Origin) == 3 &&
int(ReferrerPolicy::Origin_when_cross_origin) == 4 &&
int(ReferrerPolicy::Unsafe_url) == 5 &&
int(ReferrerPolicy::Same_origin) == 6 &&
int(ReferrerPolicy::Strict_origin) == 7 &&
int(ReferrerPolicy::Strict_origin_when_cross_origin) == 8 &&
ReferrerPolicyValues::Count == 9,
"ReferrerPolicy values are as expected");
static_assert(int(RequestMode::Same_origin) == 0 &&
int(RequestMode::No_cors) == 1 &&
int(RequestMode::Cors) == 2 &&
int(RequestMode::Navigate) == 3 &&
RequestModeValues::Count == 4,
"RequestMode values are as expected");
static_assert(int(RequestCredentials::Omit) == 0 &&
int(RequestCredentials::Same_origin) == 1 &&
int(RequestCredentials::Include) == 2 &&
RequestCredentialsValues::Count == 3,
"RequestCredentials values are as expected");
static_assert(int(RequestCache::Default) == 0 &&
int(RequestCache::No_store) == 1 &&
int(RequestCache::Reload) == 2 &&
int(RequestCache::No_cache) == 3 &&
int(RequestCache::Force_cache) == 4 &&
int(RequestCache::Only_if_cached) == 5 &&
RequestCacheValues::Count == 6,
"RequestCache values are as expected");
static_assert(int(RequestRedirect::Follow) == 0 &&
int(RequestRedirect::Error) == 1 &&
int(RequestRedirect::Manual) == 2 &&
RequestRedirectValues::Count == 3,
"RequestRedirect values are as expected");
static_assert(int(ResponseType::Basic) == 0 && int(ResponseType::Cors) == 1 &&
int(ResponseType::Default) == 2 &&
int(ResponseType::Error) == 3 &&
int(ResponseType::Opaque) == 4 &&
int(ResponseType::Opaqueredirect) == 5 &&
ResponseTypeValues::Count == 6,
"ResponseType values are as expected");
// If the static_asserts below fails, it means that you have changed the
// Namespace enum in a way that may be incompatible with the existing data
// stored in the DOM Cache. You would need to update the Cache database schema
// accordingly and adjust the failing static_assert.
static_assert(DEFAULT_NAMESPACE == 0 && CHROME_ONLY_NAMESPACE == 1 &&
NUMBER_OF_NAMESPACES == 2,
"Namespace values are as expected");
// If the static_asserts below fails, it means that you have changed the
// nsContentPolicy enum in a way that may be incompatible with the existing data
// stored in the DOM Cache. You would need to update the Cache database schema
// accordingly and adjust the failing static_assert.
static_assert(
nsIContentPolicy::TYPE_INVALID == 0 && nsIContentPolicy::TYPE_OTHER == 1 &&
nsIContentPolicy::TYPE_SCRIPT == 2 &&
nsIContentPolicy::TYPE_IMAGE == 3 &&
nsIContentPolicy::TYPE_STYLESHEET == 4 &&
nsIContentPolicy::TYPE_OBJECT == 5 &&
nsIContentPolicy::TYPE_DOCUMENT == 6 &&
nsIContentPolicy::TYPE_SUBDOCUMENT == 7 &&
nsIContentPolicy::TYPE_REFRESH == 8 &&
nsIContentPolicy::TYPE_PING == 10 &&
nsIContentPolicy::TYPE_XMLHTTPREQUEST == 11 &&
nsIContentPolicy::TYPE_DATAREQUEST == 11 &&
nsIContentPolicy::TYPE_OBJECT_SUBREQUEST == 12 &&
nsIContentPolicy::TYPE_DTD == 13 && nsIContentPolicy::TYPE_FONT == 14 &&
nsIContentPolicy::TYPE_MEDIA == 15 &&
nsIContentPolicy::TYPE_WEBSOCKET == 16 &&
nsIContentPolicy::TYPE_CSP_REPORT == 17 &&
nsIContentPolicy::TYPE_XSLT == 18 &&
nsIContentPolicy::TYPE_BEACON == 19 &&
nsIContentPolicy::TYPE_FETCH == 20 &&
nsIContentPolicy::TYPE_IMAGESET == 21 &&
nsIContentPolicy::TYPE_WEB_MANIFEST == 22 &&
nsIContentPolicy::TYPE_INTERNAL_SCRIPT == 23 &&
nsIContentPolicy::TYPE_INTERNAL_WORKER == 24 &&
nsIContentPolicy::TYPE_INTERNAL_SHARED_WORKER == 25 &&
nsIContentPolicy::TYPE_INTERNAL_EMBED == 26 &&
nsIContentPolicy::TYPE_INTERNAL_OBJECT == 27 &&
nsIContentPolicy::TYPE_INTERNAL_FRAME == 28 &&
nsIContentPolicy::TYPE_INTERNAL_IFRAME == 29 &&
nsIContentPolicy::TYPE_INTERNAL_AUDIO == 30 &&
nsIContentPolicy::TYPE_INTERNAL_VIDEO == 31 &&
nsIContentPolicy::TYPE_INTERNAL_TRACK == 32 &&
nsIContentPolicy::TYPE_INTERNAL_XMLHTTPREQUEST == 33 &&
nsIContentPolicy::TYPE_INTERNAL_EVENTSOURCE == 34 &&
nsIContentPolicy::TYPE_INTERNAL_SERVICE_WORKER == 35 &&
nsIContentPolicy::TYPE_INTERNAL_SCRIPT_PRELOAD == 36 &&
nsIContentPolicy::TYPE_INTERNAL_IMAGE == 37 &&
nsIContentPolicy::TYPE_INTERNAL_IMAGE_PRELOAD == 38 &&
nsIContentPolicy::TYPE_INTERNAL_STYLESHEET == 39 &&
nsIContentPolicy::TYPE_INTERNAL_STYLESHEET_PRELOAD == 40 &&
nsIContentPolicy::TYPE_INTERNAL_IMAGE_FAVICON == 41 &&
nsIContentPolicy::TYPE_INTERNAL_WORKER_IMPORT_SCRIPTS == 42 &&
nsIContentPolicy::TYPE_SAVEAS_DOWNLOAD == 43 &&
nsIContentPolicy::TYPE_SPECULATIVE == 44 &&
nsIContentPolicy::TYPE_INTERNAL_MODULE == 45 &&
nsIContentPolicy::TYPE_INTERNAL_MODULE_PRELOAD == 46 &&
nsIContentPolicy::TYPE_INTERNAL_DTD == 47 &&
nsIContentPolicy::TYPE_INTERNAL_FORCE_ALLOWED_DTD == 48 &&
nsIContentPolicy::TYPE_INTERNAL_AUDIOWORKLET == 49 &&
nsIContentPolicy::TYPE_INTERNAL_PAINTWORKLET == 50 &&
nsIContentPolicy::TYPE_INTERNAL_FONT_PRELOAD == 51 &&
nsIContentPolicy::TYPE_INTERNAL_CHROMEUTILS_COMPILED_SCRIPT == 52 &&
nsIContentPolicy::TYPE_INTERNAL_FRAME_MESSAGEMANAGER_SCRIPT == 53 &&
nsIContentPolicy::TYPE_INTERNAL_FETCH_PRELOAD == 54,
"nsContentPolicyType values are as expected");
namespace {
typedef int32_t EntryId;
struct IdCount {
explicit IdCount(int32_t aId) : mId(aId), mCount(1) {}
int32_t mId;
int32_t mCount;
};
static Result<nsTArray<EntryId>, nsresult> QueryAll(
mozIStorageConnection& aConn, CacheId aCacheId);
static Result<nsTArray<EntryId>, nsresult> QueryCache(
mozIStorageConnection& aConn, CacheId aCacheId,
const CacheRequest& aRequest, const CacheQueryParams& aParams,
uint32_t aMaxResults = UINT32_MAX);
static Result<bool, nsresult> MatchByVaryHeader(mozIStorageConnection& aConn,
const CacheRequest& aRequest,
EntryId entryId);
// ToDo: Replace output parameters by return values.
static nsresult DeleteEntries(mozIStorageConnection& aConn,
const nsTArray<EntryId>& aEntryIdList,
nsTArray<nsID>& aDeletedBodyIdListOut,
nsTArray<IdCount>& aDeletedSecurityIdListOut,
int64_t* aDeletedPaddingSizeOut,
uint32_t aPos = 0, int32_t aLen = -1);
static Result<int32_t, nsresult> InsertSecurityInfo(
mozIStorageConnection& aConn, nsICryptoHash& aCrypto,
const nsACString& aData);
static nsresult DeleteSecurityInfo(mozIStorageConnection& aConn, int32_t aId,
int32_t aCount);
static nsresult DeleteSecurityInfoList(
mozIStorageConnection& aConn,
const nsTArray<IdCount>& aDeletedStorageIdList);
static nsresult InsertEntry(mozIStorageConnection& aConn, CacheId aCacheId,
const CacheRequest& aRequest,
const nsID* aRequestBodyId,
const CacheResponse& aResponse,
const nsID* aResponseBodyId);
static Result<SavedResponse, nsresult> ReadResponse(
mozIStorageConnection& aConn, EntryId aEntryId);
static Result<SavedRequest, nsresult> ReadRequest(mozIStorageConnection& aConn,
EntryId aEntryId);
static void AppendListParamsToQuery(nsACString& aQuery,
const nsTArray<EntryId>& aEntryIdList,
uint32_t aPos, int32_t aLen);
static nsresult BindListParamsToQuery(mozIStorageStatement& aState,
const nsTArray<EntryId>& aEntryIdList,
uint32_t aPos, int32_t aLen);
static nsresult BindId(mozIStorageStatement& aState, const nsACString& aName,
const nsID* aId);
static Result<nsID, nsresult> ExtractId(mozIStorageStatement& aState,
uint32_t aPos);
static Result<MovingNotNull<nsCOMPtr<mozIStorageStatement>>, nsresult>
CreateAndBindKeyStatement(mozIStorageConnection& aConn,
const char* aQueryFormat, const nsAString& aKey);
static Result<nsAutoCString, nsresult> HashCString(nsICryptoHash& aCrypto,
const nsACString& aIn);
Result<int32_t, nsresult> GetEffectiveSchemaVersion(
mozIStorageConnection& aConn);
nsresult Validate(mozIStorageConnection& aConn);
nsresult Migrate(mozIStorageConnection& aConn);
} // namespace
class MOZ_RAII AutoDisableForeignKeyChecking {
public:
explicit AutoDisableForeignKeyChecking(mozIStorageConnection* aConn)
: mConn(aConn), mForeignKeyCheckingDisabled(false) {
nsCOMPtr<mozIStorageStatement> state;
nsresult rv = mConn->CreateStatement("PRAGMA foreign_keys;"_ns,
getter_AddRefs(state));
if (NS_WARN_IF(NS_FAILED(rv))) {
return;
}
bool hasMoreData = false;
rv = state->ExecuteStep(&hasMoreData);
if (NS_WARN_IF(NS_FAILED(rv))) {
return;
}
int32_t mode;
rv = state->GetInt32(0, &mode);
if (NS_WARN_IF(NS_FAILED(rv))) {
return;
}
if (mode) {
nsresult rv = mConn->ExecuteSimpleSQL("PRAGMA foreign_keys = OFF;"_ns);
if (NS_WARN_IF(NS_FAILED(rv))) {
return;
}
mForeignKeyCheckingDisabled = true;
}
}
~AutoDisableForeignKeyChecking() {
if (mForeignKeyCheckingDisabled) {
nsresult rv = mConn->ExecuteSimpleSQL("PRAGMA foreign_keys = ON;"_ns);
if (NS_WARN_IF(NS_FAILED(rv))) {
return;
}
}
}
private:
nsCOMPtr<mozIStorageConnection> mConn;
bool mForeignKeyCheckingDisabled;
};
nsresult CreateOrMigrateSchema(mozIStorageConnection& aConn) {
MOZ_ASSERT(!NS_IsMainThread());
int32_t schemaVersion;
CACHE_TRY_VAR(schemaVersion, GetEffectiveSchemaVersion(aConn));
if (schemaVersion == kLatestSchemaVersion) {
// We already have the correct schema version. Validate it matches
// our expected schema and then proceed.
nsresult rv = Validate(aConn);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
return rv;
}
// Turn off checking foreign keys before starting a transaction, and restore
// it once we're done.
AutoDisableForeignKeyChecking restoreForeignKeyChecking(&aConn);
mozStorageTransaction trans(&aConn, false,
mozIStorageConnection::TRANSACTION_IMMEDIATE);
bool needVacuum = false;
if (schemaVersion) {
// A schema exists, but its not the current version. Attempt to
// migrate it to our new schema.
nsresult rv = Migrate(aConn);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
// Migrations happen infrequently and reflect a chance in DB structure.
// This is a good time to rebuild the database. It also helps catch
// if a new migration is incorrect by fast failing on the corruption.
needVacuum = true;
} else {
// There is no schema installed. Create the database from scratch.
nsresult rv = aConn.ExecuteSimpleSQL(nsDependentCString(kTableCaches));
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
rv = aConn.ExecuteSimpleSQL(nsDependentCString(kTableSecurityInfo));
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
rv = aConn.ExecuteSimpleSQL(nsDependentCString(kIndexSecurityInfoHash));
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
rv = aConn.ExecuteSimpleSQL(nsDependentCString(kTableEntries));
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
rv = aConn.ExecuteSimpleSQL(nsDependentCString(kIndexEntriesRequest));
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
rv = aConn.ExecuteSimpleSQL(nsDependentCString(kTableRequestHeaders));
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
rv = aConn.ExecuteSimpleSQL(nsDependentCString(kTableResponseHeaders));
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
rv = aConn.ExecuteSimpleSQL(nsDependentCString(kIndexResponseHeadersName));
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
rv = aConn.ExecuteSimpleSQL(nsDependentCString(kTableResponseUrlList));
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
rv = aConn.ExecuteSimpleSQL(nsDependentCString(kTableStorage));
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
rv = aConn.SetSchemaVersion(kHackyDowngradeSchemaVersion);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
CACHE_TRY_VAR(schemaVersion, GetEffectiveSchemaVersion(aConn));
}
nsresult rv = Validate(aConn);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
rv = trans.Commit();
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
if (needVacuum) {
// Unfortunately, this must be performed outside of the transaction.
aConn.ExecuteSimpleSQL("VACUUM"_ns);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
}
return rv;
}
nsresult InitializeConnection(mozIStorageConnection& aConn) {
MOZ_ASSERT(!NS_IsMainThread());
// This function needs to perform per-connection initialization tasks that
// need to happen regardless of the schema.
nsPrintfCString pragmas(
// Use a smaller page size to improve perf/footprint; default is too large
"PRAGMA page_size = %u; "
// Enable auto_vacuum; this must happen after page_size and before WAL
"PRAGMA auto_vacuum = INCREMENTAL; "
"PRAGMA foreign_keys = ON; ",
kPageSize);
// Note, the default encoding of UTF-8 is preferred. mozStorage does all
// the work necessary to convert UTF-16 nsString values for us. We don't
// need ordering and the binary equality operations are correct. So, do
// NOT set PRAGMA encoding to UTF-16.
nsresult rv = aConn.ExecuteSimpleSQL(pragmas);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
// Limit fragmentation by growing the database by many pages at once.
rv = aConn.SetGrowthIncrement(kGrowthSize, EmptyCString());
if (rv == NS_ERROR_FILE_TOO_BIG) {
NS_WARNING("Not enough disk space to set sqlite growth increment.");
rv = NS_OK;
}
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
// Enable WAL journaling. This must be performed in a separate transaction
// after changing the page_size and enabling auto_vacuum.
nsPrintfCString wal(
// WAL journal can grow to given number of *pages*
"PRAGMA wal_autocheckpoint = %u; "
// Always truncate the journal back to given number of *bytes*
"PRAGMA journal_size_limit = %u; "
// WAL must be enabled at the end to allow page size to be changed, etc.
"PRAGMA journal_mode = WAL; ",
kWalAutoCheckpointPages, kWalAutoCheckpointSize);
rv = aConn.ExecuteSimpleSQL(wal);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
// Verify that we successfully set the vacuum mode to incremental. It
// is very easy to put the database in a state where the auto_vacuum
// pragma above fails silently.
#ifdef DEBUG
nsCOMPtr<mozIStorageStatement> state;
rv = aConn.CreateStatement("PRAGMA auto_vacuum;"_ns, getter_AddRefs(state));
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
bool hasMoreData = false;
rv = state->ExecuteStep(&hasMoreData);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
int32_t mode;
rv = state->GetInt32(0, &mode);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
// integer value 2 is incremental mode
if (NS_WARN_IF(mode != 2)) {
return NS_ERROR_UNEXPECTED;
}
#endif
return NS_OK;
}
Result<CacheId, nsresult> CreateCacheId(mozIStorageConnection& aConn) {
MOZ_ASSERT(!NS_IsMainThread());
nsresult rv = aConn.ExecuteSimpleSQL("INSERT INTO caches DEFAULT VALUES;"_ns);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
nsCOMPtr<mozIStorageStatement> state;
rv = aConn.CreateStatement("SELECT last_insert_rowid()"_ns,
getter_AddRefs(state));
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
bool hasMoreData = false;
rv = state->ExecuteStep(&hasMoreData);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
if (NS_WARN_IF(!hasMoreData)) {
return Err(NS_ERROR_UNEXPECTED);
}
CacheId id;
rv = state->GetInt64(0, &id);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
return id;
}
Result<DeletionInfo, nsresult> DeleteCacheId(mozIStorageConnection& aConn,
CacheId aCacheId) {
MOZ_ASSERT(!NS_IsMainThread());
// Delete the bodies explicitly as we need to read out the body IDs
// anyway. These body IDs must be deleted one-by-one as content may
// still be referencing them invidivually.
AutoTArray<EntryId, 256> matches;
CACHE_TRY_VAR(matches, QueryAll(aConn, aCacheId));
AutoTArray<nsID, 16> deletedBodyIdList;
AutoTArray<IdCount, 16> deletedSecurityIdList;
int64_t deletedPaddingSize = 0;
nsresult rv = DeleteEntries(aConn, matches, deletedBodyIdList,
deletedSecurityIdList, &deletedPaddingSize);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
rv = DeleteSecurityInfoList(aConn, deletedSecurityIdList);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
// Delete the remainder of the cache using cascade semantics.
nsCOMPtr<mozIStorageStatement> state;
rv = aConn.CreateStatement("DELETE FROM caches WHERE id=:id;"_ns,
getter_AddRefs(state));
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
rv = state->BindInt64ByName("id"_ns, aCacheId);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
rv = state->Execute();
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
return DeletionInfo{std::move(deletedBodyIdList), deletedPaddingSize};
}
Result<nsTArray<CacheId>, nsresult> FindOrphanedCacheIds(
mozIStorageConnection& aConn) {
nsCOMPtr<mozIStorageStatement> state;
nsresult rv = aConn.CreateStatement(
"SELECT id FROM caches "
"WHERE id NOT IN (SELECT cache_id from storage);"_ns,
getter_AddRefs(state));
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
AutoTArray<CacheId, 8> orphanedList;
bool hasMoreData = false;
while (NS_SUCCEEDED(state->ExecuteStep(&hasMoreData)) && hasMoreData) {
CacheId cacheId = INVALID_CACHE_ID;
rv = state->GetInt64(0, &cacheId);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
orphanedList.AppendElement(cacheId);
}
return std::move(orphanedList);
}
Result<int64_t, nsresult> FindOverallPaddingSize(mozIStorageConnection& aConn) {
nsCOMPtr<mozIStorageStatement> state;
nsresult rv = aConn.CreateStatement(
"SELECT response_padding_size FROM entries "
"WHERE response_padding_size IS NOT NULL;"_ns,
getter_AddRefs(state));
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
int64_t overallPaddingSize = 0;
bool hasMoreData = false;
while (NS_SUCCEEDED(state->ExecuteStep(&hasMoreData)) && hasMoreData) {
int64_t padding_size = 0;
rv = state->GetInt64(0, &padding_size);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
MOZ_DIAGNOSTIC_ASSERT(padding_size >= 0);
MOZ_DIAGNOSTIC_ASSERT(INT64_MAX - padding_size >= overallPaddingSize);
overallPaddingSize += padding_size;
}
return overallPaddingSize;
}
Result<nsTArray<nsID>, nsresult> GetKnownBodyIds(mozIStorageConnection& aConn) {
MOZ_ASSERT(!NS_IsMainThread());
nsCOMPtr<mozIStorageStatement> state;
nsresult rv = aConn.CreateStatement(
nsLiteralCString(
"SELECT request_body_id, response_body_id FROM entries;"),
getter_AddRefs(state));
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
AutoTArray<nsID, 64> idList;
bool hasMoreData = false;
while (NS_SUCCEEDED(state->ExecuteStep(&hasMoreData)) && hasMoreData) {
// extract 0 to 2 nsID structs per row
for (uint32_t i = 0; i < 2; ++i) {
bool isNull = false;
rv = state->GetIsNull(i, &isNull);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
if (!isNull) {
nsID id;
CACHE_TRY_VAR(id, ExtractId(*state, i));
idList.AppendElement(id);
}
}
}
return std::move(idList);
}
Result<Maybe<SavedResponse>, nsresult> CacheMatch(
mozIStorageConnection& aConn, CacheId aCacheId,
const CacheRequest& aRequest, const CacheQueryParams& aParams) {
MOZ_ASSERT(!NS_IsMainThread());
AutoTArray<EntryId, 1> matches;
CACHE_TRY_VAR(matches, QueryCache(aConn, aCacheId, aRequest, aParams, 1));
if (matches.IsEmpty()) {
return Maybe<SavedResponse>();
}
SavedResponse response;
CACHE_TRY_VAR(response, ReadResponse(aConn, matches[0]));
response.mCacheId = aCacheId;
return Some(response);
}
Result<nsTArray<SavedResponse>, nsresult> CacheMatchAll(
mozIStorageConnection& aConn, CacheId aCacheId,
const Maybe<CacheRequest>& aMaybeRequest, const CacheQueryParams& aParams) {
MOZ_ASSERT(!NS_IsMainThread());
AutoTArray<EntryId, 256> matches;
if (aMaybeRequest.isNothing()) {
CACHE_TRY_VAR(matches, QueryAll(aConn, aCacheId));
} else {
CACHE_TRY_VAR(matches,
QueryCache(aConn, aCacheId, aMaybeRequest.ref(), aParams));
}
nsTArray<SavedResponse> savedResponses;
// TODO: replace this with a bulk load using SQL IN clause (bug 1110458)
for (const auto match : matches) {
SavedResponse savedResponse;
CACHE_TRY_VAR(savedResponse, ReadResponse(aConn, match));
savedResponse.mCacheId = aCacheId;
savedResponses.AppendElement(savedResponse);
}
return savedResponses;
}
Result<DeletionInfo, nsresult> CachePut(mozIStorageConnection& aConn,
CacheId aCacheId,
const CacheRequest& aRequest,
const nsID* aRequestBodyId,
const CacheResponse& aResponse,
const nsID* aResponseBodyId) {
MOZ_ASSERT(!NS_IsMainThread());
CacheQueryParams params(false, false, false, false, u""_ns);
AutoTArray<EntryId, 256> matches;
CACHE_TRY_VAR(matches, QueryCache(aConn, aCacheId, aRequest, params));
nsTArray<nsID> deletedBodyIdList;
AutoTArray<IdCount, 16> deletedSecurityIdList;
int64_t deletedPaddingSize = 0;
nsresult rv = DeleteEntries(aConn, matches, deletedBodyIdList,
deletedSecurityIdList, &deletedPaddingSize);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
rv = InsertEntry(aConn, aCacheId, aRequest, aRequestBodyId, aResponse,
aResponseBodyId);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
// Delete the security values after doing the insert to avoid churning
// the security table when its not necessary.
rv = DeleteSecurityInfoList(aConn, deletedSecurityIdList);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
return DeletionInfo{std::move(deletedBodyIdList), deletedPaddingSize};
}
Result<Maybe<DeletionInfo>, nsresult> CacheDelete(
mozIStorageConnection& aConn, CacheId aCacheId,
const CacheRequest& aRequest, const CacheQueryParams& aParams) {
MOZ_ASSERT(!NS_IsMainThread());
AutoTArray<EntryId, 256> matches;
CACHE_TRY_VAR(matches, QueryCache(aConn, aCacheId, aRequest, aParams));
if (matches.IsEmpty()) {
return Maybe<DeletionInfo>();
}
nsTArray<nsID> deletedBodyIdList;
AutoTArray<IdCount, 16> deletedSecurityIdList;
int64_t deletedPaddingSize = 0;
nsresult rv = DeleteEntries(aConn, matches, deletedBodyIdList,
deletedSecurityIdList, &deletedPaddingSize);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
rv = DeleteSecurityInfoList(aConn, deletedSecurityIdList);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
return Some(DeletionInfo{std::move(deletedBodyIdList), deletedPaddingSize});
}
Result<nsTArray<SavedRequest>, nsresult> CacheKeys(
mozIStorageConnection& aConn, CacheId aCacheId,
const Maybe<CacheRequest>& aMaybeRequest, const CacheQueryParams& aParams) {
MOZ_ASSERT(!NS_IsMainThread());
AutoTArray<EntryId, 256> matches;
if (aMaybeRequest.isNothing()) {
CACHE_TRY_VAR(matches, QueryAll(aConn, aCacheId));
} else {
CACHE_TRY_VAR(matches,
QueryCache(aConn, aCacheId, aMaybeRequest.ref(), aParams));
}
nsTArray<SavedRequest> savedRequests;
// TODO: replace this with a bulk load using SQL IN clause (bug 1110458)
for (const auto match : matches) {
SavedRequest savedRequest;
CACHE_TRY_VAR(savedRequest, ReadRequest(aConn, match));
savedRequest.mCacheId = aCacheId;
savedRequests.AppendElement(savedRequest);
}
return savedRequests;
}
Result<Maybe<SavedResponse>, nsresult> StorageMatch(
mozIStorageConnection& aConn, Namespace aNamespace,
const CacheRequest& aRequest, const CacheQueryParams& aParams) {
MOZ_ASSERT(!NS_IsMainThread());
nsresult rv;
// If we are given a cache to check, then simply find its cache ID
// and perform the match.
if (!aParams.cacheName().EqualsLiteral("")) {
Maybe<CacheId> maybeCacheId;
CACHE_TRY_VAR(maybeCacheId,
StorageGetCacheId(aConn, aNamespace, aParams.cacheName()));
if (maybeCacheId.isNothing()) {
return Maybe<SavedResponse>();
}
return CacheMatch(aConn, maybeCacheId.ref(), aRequest, aParams);
}
// Otherwise we need to get a list of all the cache IDs in this namespace.
nsCOMPtr<mozIStorageStatement> state;
rv = aConn.CreateStatement(
"SELECT cache_id FROM storage WHERE "
"namespace=:namespace ORDER BY rowid;"_ns,
getter_AddRefs(state));
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
rv = state->BindInt32ByName("namespace"_ns, aNamespace);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
AutoTArray<CacheId, 32> cacheIdList;
bool hasMoreData = false;
while (NS_SUCCEEDED(state->ExecuteStep(&hasMoreData)) && hasMoreData) {
CacheId cacheId = INVALID_CACHE_ID;
rv = state->GetInt64(0, &cacheId);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
cacheIdList.AppendElement(cacheId);
}
// Now try to find a match in each cache in order
for (const auto cacheId : cacheIdList) {
Maybe<SavedResponse> matchedResponse;
CACHE_TRY_VAR(matchedResponse,
CacheMatch(aConn, cacheId, aRequest, aParams));
if (matchedResponse.isSome()) {
return matchedResponse;
}
}
return Maybe<SavedResponse>();
}
Result<Maybe<CacheId>, nsresult> StorageGetCacheId(mozIStorageConnection& aConn,
Namespace aNamespace,
const nsAString& aKey) {
MOZ_ASSERT(!NS_IsMainThread());
// How we constrain the key column depends on the value of our key. Use
// a format string for the query and let CreateAndBindKeyStatement() fill
// it in for us.
const char* query =
"SELECT cache_id FROM storage "
"WHERE namespace=:namespace AND %s "
"ORDER BY rowid;";
nsCOMPtr<mozIStorageStatement> state;
CACHE_TRY_VAR(state, CreateAndBindKeyStatement(aConn, query, aKey));
nsresult rv = state->BindInt32ByName("namespace"_ns, aNamespace);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
bool hasMoreData = false;
rv = state->ExecuteStep(&hasMoreData);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
if (!hasMoreData) {
return Maybe<CacheId>();
}
CacheId cacheId;
rv = state->GetInt64(0, &cacheId);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
return Some(cacheId);
}
nsresult StoragePutCache(mozIStorageConnection& aConn, Namespace aNamespace,
const nsAString& aKey, CacheId aCacheId) {
MOZ_ASSERT(!NS_IsMainThread());
nsCOMPtr<mozIStorageStatement> state;
nsresult rv = aConn.CreateStatement(
"INSERT INTO storage (namespace, key, cache_id) "
"VALUES (:namespace, :key, :cache_id);"_ns,
getter_AddRefs(state));
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
rv = state->BindInt32ByName("namespace"_ns, aNamespace);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
rv = state->BindStringAsBlobByName("key"_ns, aKey);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
rv = state->BindInt64ByName("cache_id"_ns, aCacheId);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
rv = state->Execute();
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
return rv;
}
nsresult StorageForgetCache(mozIStorageConnection& aConn, Namespace aNamespace,
const nsAString& aKey) {
MOZ_ASSERT(!NS_IsMainThread());
// How we constrain the key column depends on the value of our key. Use
// a format string for the query and let CreateAndBindKeyStatement() fill
// it in for us.
const char* query = "DELETE FROM storage WHERE namespace=:namespace AND %s;";
nsCOMPtr<mozIStorageStatement> state;
CACHE_TRY_VAR(state, CreateAndBindKeyStatement(aConn, query, aKey));
nsresult rv = state->BindInt32ByName("namespace"_ns, aNamespace);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
rv = state->Execute();
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
return rv;
}
Result<nsTArray<nsString>, nsresult> StorageGetKeys(
mozIStorageConnection& aConn, Namespace aNamespace) {
MOZ_ASSERT(!NS_IsMainThread());
nsCOMPtr<mozIStorageStatement> state;
nsresult rv = aConn.CreateStatement(
nsLiteralCString(
"SELECT key FROM storage WHERE namespace=:namespace ORDER BY rowid;"),
getter_AddRefs(state));
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
rv = state->BindInt32ByName("namespace"_ns, aNamespace);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
nsTArray<nsString> keys;
bool hasMoreData = false;
while (NS_SUCCEEDED(state->ExecuteStep(&hasMoreData)) && hasMoreData) {
nsAutoString key;
rv = state->GetBlobAsString(0, key);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
keys.AppendElement(key);
}
return std::move(keys);
}
namespace {
Result<nsTArray<EntryId>, nsresult> QueryAll(mozIStorageConnection& aConn,
CacheId aCacheId) {
MOZ_ASSERT(!NS_IsMainThread());
nsCOMPtr<mozIStorageStatement> state;
nsresult rv = aConn.CreateStatement(
nsLiteralCString(
"SELECT id FROM entries WHERE cache_id=:cache_id ORDER BY id;"),
getter_AddRefs(state));
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
rv = state->BindInt64ByName("cache_id"_ns, aCacheId);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
AutoTArray<EntryId, 256> entryIdList;
bool hasMoreData = false;
while (NS_SUCCEEDED(state->ExecuteStep(&hasMoreData)) && hasMoreData) {
EntryId entryId = INT32_MAX;
rv = state->GetInt32(0, &entryId);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
entryIdList.AppendElement(entryId);
}
return std::move(entryIdList);
}
Result<nsTArray<EntryId>, nsresult> QueryCache(mozIStorageConnection& aConn,
CacheId aCacheId,
const CacheRequest& aRequest,
const CacheQueryParams& aParams,
uint32_t aMaxResults) {
MOZ_ASSERT(!NS_IsMainThread());
MOZ_DIAGNOSTIC_ASSERT(aMaxResults > 0);
AutoTArray<EntryId, 256> entryIdList;
if (!aParams.ignoreMethod() &&
!aRequest.method().LowerCaseEqualsLiteral("get")) {
return std::move(entryIdList);
}
nsAutoCString query(
"SELECT id, COUNT(response_headers.name) AS vary_count "
"FROM entries "
"LEFT OUTER JOIN response_headers ON "
"entries.id=response_headers.entry_id "
"AND response_headers.name='vary' COLLATE NOCASE "
"WHERE entries.cache_id=:cache_id "
"AND entries.request_url_no_query_hash=:url_no_query_hash ");
if (!aParams.ignoreSearch()) {
query.AppendLiteral("AND entries.request_url_query_hash=:url_query_hash ");
}
query.AppendLiteral("AND entries.request_url_no_query=:url_no_query ");
if (!aParams.ignoreSearch()) {
query.AppendLiteral("AND entries.request_url_query=:url_query ");
}
query.AppendLiteral("GROUP BY entries.id ORDER BY entries.id;");
nsCOMPtr<mozIStorageStatement> state;
nsresult rv = aConn.CreateStatement(query, getter_AddRefs(state));
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
rv = state->BindInt64ByName("cache_id"_ns, aCacheId);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
nsCOMPtr<nsICryptoHash> crypto =
do_CreateInstance(NS_CRYPTO_HASH_CONTRACTID, &rv);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
CACHE_TRY_VAR(const auto urlWithoutQueryHash,
HashCString(*crypto, aRequest.urlWithoutQuery()));
rv = state->BindUTF8StringAsBlobByName("url_no_query_hash"_ns,
urlWithoutQueryHash);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
if (!aParams.ignoreSearch()) {
CACHE_TRY_VAR(const auto urlQueryHash,
HashCString(*crypto, aRequest.urlQuery()));
rv = state->BindUTF8StringAsBlobByName("url_query_hash"_ns, urlQueryHash);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
}
rv = state->BindUTF8StringByName("url_no_query"_ns,
aRequest.urlWithoutQuery());
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
if (!aParams.ignoreSearch()) {
rv = state->BindUTF8StringByName("url_query"_ns, aRequest.urlQuery());
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
}
bool hasMoreData = false;
while (NS_SUCCEEDED(state->ExecuteStep(&hasMoreData)) && hasMoreData) {
// no invalid EntryId, init to least likely real value
EntryId entryId = INT32_MAX;
rv = state->GetInt32(0, &entryId);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
int32_t varyCount;
rv = state->GetInt32(1, &varyCount);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
if (!aParams.ignoreVary() && varyCount > 0) {
bool matchedByVary = false;
CACHE_TRY_VAR(matchedByVary, MatchByVaryHeader(aConn, aRequest, entryId));
if (!matchedByVary) {
continue;
}
}
entryIdList.AppendElement(entryId);
if (entryIdList.Length() == aMaxResults) {
return std::move(entryIdList);
}
}
return std::move(entryIdList);
}
Result<bool, nsresult> MatchByVaryHeader(mozIStorageConnection& aConn,
const CacheRequest& aRequest,
EntryId entryId) {
MOZ_ASSERT(!NS_IsMainThread());
nsCOMPtr<mozIStorageStatement> state;
nsresult rv = aConn.CreateStatement(
"SELECT value FROM response_headers "
"WHERE name='vary' COLLATE NOCASE "
"AND entry_id=:entry_id;"_ns,
getter_AddRefs(state));
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
rv = state->BindInt32ByName("entry_id"_ns, entryId);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
AutoTArray<nsCString, 8> varyValues;
bool hasMoreData = false;
while (NS_SUCCEEDED(state->ExecuteStep(&hasMoreData)) && hasMoreData) {
nsAutoCString value;
rv = state->GetUTF8String(0, value);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
varyValues.AppendElement(value);
}
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
// Should not have called this function if this was not the case
MOZ_DIAGNOSTIC_ASSERT(!varyValues.IsEmpty());
state->Reset();
rv = aConn.CreateStatement(
"SELECT name, value FROM request_headers "
"WHERE entry_id=:entry_id;"_ns,
getter_AddRefs(state));
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
rv = state->BindInt32ByName("entry_id"_ns, entryId);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
RefPtr<InternalHeaders> cachedHeaders =
new InternalHeaders(HeadersGuardEnum::None);
while (NS_SUCCEEDED(state->ExecuteStep(&hasMoreData)) && hasMoreData) {
nsAutoCString name;
nsAutoCString value;
rv = state->GetUTF8String(0, name);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
rv = state->GetUTF8String(1, value);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
ErrorResult errorResult;
cachedHeaders->Append(name, value, errorResult);
if (errorResult.Failed()) {
return Err(errorResult.StealNSResult());
}
}
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
RefPtr<InternalHeaders> queryHeaders =
TypeUtils::ToInternalHeaders(aRequest.headers());
// Assume the vary headers match until we find a conflict
bool varyHeadersMatch = true;
for (auto& varyValue : varyValues) {
// Extract the header names inside the Vary header value.
char* rawBuffer = varyValue.BeginWriting();
char* token = nsCRT::strtok(rawBuffer, NS_HTTP_HEADER_SEPS, &rawBuffer);
bool bailOut = false;
for (; token;
token = nsCRT::strtok(rawBuffer, NS_HTTP_HEADER_SEPS, &rawBuffer)) {
nsDependentCString header(token);
MOZ_DIAGNOSTIC_ASSERT(!header.EqualsLiteral("*"),
"We should have already caught this in "
"TypeUtils::ToPCacheResponseWithoutBody()");
ErrorResult errorResult;
nsAutoCString queryValue;
queryHeaders->Get(header, queryValue, errorResult);
if (errorResult.Failed()) {
errorResult.SuppressException();
MOZ_DIAGNOSTIC_ASSERT(queryValue.IsEmpty());
}
nsAutoCString cachedValue;
cachedHeaders->Get(header, cachedValue, errorResult);
if (errorResult.Failed()) {
errorResult.SuppressException();
MOZ_DIAGNOSTIC_ASSERT(cachedValue.IsEmpty());
}
if (queryValue != cachedValue) {
varyHeadersMatch = false;
bailOut = true;
break;
}
}
if (bailOut) {
break;
}
}
return varyHeadersMatch;
}
nsresult DeleteEntries(mozIStorageConnection& aConn,
const nsTArray<EntryId>& aEntryIdList,
nsTArray<nsID>& aDeletedBodyIdListOut,
nsTArray<IdCount>& aDeletedSecurityIdListOut,
int64_t* aDeletedPaddingSizeOut, uint32_t aPos,
int32_t aLen) {
MOZ_ASSERT(!NS_IsMainThread());
MOZ_DIAGNOSTIC_ASSERT(aDeletedPaddingSizeOut);
if (aEntryIdList.IsEmpty()) {
return NS_OK;
}
MOZ_DIAGNOSTIC_ASSERT(aPos < aEntryIdList.Length());
if (aLen < 0) {
aLen = aEntryIdList.Length() - aPos;
}
// Sqlite limits the number of entries allowed for an IN clause,
// so split up larger operations.
if (aLen > kMaxEntriesPerStatement) {
int64_t overallDeletedPaddingSize = 0;
uint32_t curPos = aPos;
int32_t remaining = aLen;
while (remaining > 0) {
int64_t deletedPaddingSize = 0;
int32_t max = kMaxEntriesPerStatement;
int32_t curLen = std::min(max, remaining);
nsresult rv = DeleteEntries(aConn, aEntryIdList, aDeletedBodyIdListOut,
aDeletedSecurityIdListOut,
&deletedPaddingSize, curPos, curLen);
if (NS_FAILED(rv)) {
return rv;
}
MOZ_DIAGNOSTIC_ASSERT(INT64_MAX - deletedPaddingSize >=
overallDeletedPaddingSize);
overallDeletedPaddingSize += deletedPaddingSize;
curPos += curLen;
remaining -= curLen;
}
*aDeletedPaddingSizeOut += overallDeletedPaddingSize;
return NS_OK;
}
nsCOMPtr<mozIStorageStatement> state;
nsAutoCString query(
"SELECT "
"request_body_id, "
"response_body_id, "
"response_security_info_id, "
"response_padding_size "
"FROM entries WHERE id IN (");
AppendListParamsToQuery(query, aEntryIdList, aPos, aLen);
query.AppendLiteral(")");
nsresult rv = aConn.CreateStatement(query, getter_AddRefs(state));
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
rv = BindListParamsToQuery(*state, aEntryIdList, aPos, aLen);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
int64_t overallPaddingSize = 0;
bool hasMoreData = false;
while (NS_SUCCEEDED(state->ExecuteStep(&hasMoreData)) && hasMoreData) {
// extract 0 to 2 nsID structs per row
for (uint32_t i = 0; i < 2; ++i) {
bool isNull = false;
rv = state->GetIsNull(i, &isNull);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
if (!isNull) {
nsID id;
CACHE_TRY_VAR(id, ExtractId(*state, i));
aDeletedBodyIdListOut.AppendElement(id);
}
}
// and then a possible third entry for the security id
bool isNull = false;
rv = state->GetIsNull(2, &isNull);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
if (!isNull) {
int32_t securityId = -1;
rv = state->GetInt32(2, &securityId);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
// XXXtt: Consider using map for aDeletedSecuityIdListOut.
auto foundIt = std::find_if(aDeletedSecurityIdListOut.begin(),
aDeletedSecurityIdListOut.end(),
[securityId](const auto& deletedSecurityId) {
return deletedSecurityId.mId == securityId;
});
if (foundIt == aDeletedSecurityIdListOut.end()) {
// Add a new entry for this ID with a count of 1, if it's not in the
// list
aDeletedSecurityIdListOut.AppendElement(IdCount(securityId));
} else {
// Otherwise, increment the count for this ID
foundIt->mCount += 1;
}
}
// It's possible to have null padding size for non-opaque response
rv = state->GetIsNull(3, &isNull);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
if (!isNull) {
int64_t paddingSize = 0;
rv = state->GetInt64(3, &paddingSize);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
MOZ_DIAGNOSTIC_ASSERT(paddingSize >= 0);
MOZ_DIAGNOSTIC_ASSERT(INT64_MAX - overallPaddingSize >= paddingSize);
overallPaddingSize += paddingSize;
}
}
*aDeletedPaddingSizeOut = overallPaddingSize;
// Dependent records removed via ON DELETE CASCADE
query = "DELETE FROM entries WHERE id IN ("_ns;
AppendListParamsToQuery(query, aEntryIdList, aPos, aLen);
query.AppendLiteral(")");
rv = aConn.CreateStatement(query, getter_AddRefs(state));
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
rv = BindListParamsToQuery(*state, aEntryIdList, aPos, aLen);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
rv = state->Execute();
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
return rv;
}
Result<int32_t, nsresult> InsertSecurityInfo(mozIStorageConnection& aConn,
nsICryptoHash& aCrypto,
const nsACString& aData) {
MOZ_DIAGNOSTIC_ASSERT(!aData.IsEmpty());
// We want to use an index to find existing security blobs, but indexing
// the full blob would be quite expensive. Instead, we index a small
// hash value. Calculate this hash as the first 8 bytes of the SHA1 of
// the full data.
CACHE_TRY_VAR(const auto hash, HashCString(aCrypto, aData));
// Next, search for an existing entry for this blob by comparing the hash
// value first and then the full data. SQLite is smart enough to use
// the index on the hash to search the table before doing the expensive
// comparison of the large data column. (This was verified with EXPLAIN.)
nsCOMPtr<mozIStorageStatement> state;
nsresult rv = aConn.CreateStatement(
nsLiteralCString(
// Note that hash and data are blobs, but we can use = here since the
// columns are NOT NULL.
"SELECT id, refcount FROM security_info WHERE hash=:hash AND "
"data=:data;"),
getter_AddRefs(state));
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
rv = state->BindUTF8StringAsBlobByName("hash"_ns, hash);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
rv = state->BindUTF8StringAsBlobByName("data"_ns, aData);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
bool hasMoreData = false;
rv = state->ExecuteStep(&hasMoreData);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
// This security info blob is already in the database
if (hasMoreData) {
int32_t id;
// get the existing security blob id to return
rv = state->GetInt32(0, &id);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
int32_t refcount = -1;
rv = state->GetInt32(1, &refcount);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
// But first, update the refcount in the database.
refcount += 1;
rv = aConn.CreateStatement(
nsLiteralCString(
"UPDATE security_info SET refcount=:refcount WHERE id=:id;"),
getter_AddRefs(state));
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
rv = state->BindInt32ByName("refcount"_ns, refcount);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
rv = state->BindInt32ByName("id"_ns, id);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
rv = state->Execute();
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
return id;
}
// This is a new security info blob. Create a new row in the security table
// with an initial refcount of 1.
rv = aConn.CreateStatement(
"INSERT INTO security_info (hash, data, refcount) "
"VALUES (:hash, :data, 1);"_ns,
getter_AddRefs(state));
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
rv = state->BindUTF8StringAsBlobByName("hash"_ns, hash);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
rv = state->BindUTF8StringAsBlobByName("data"_ns, aData);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
rv = state->Execute();
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
rv = aConn.CreateStatement("SELECT last_insert_rowid()"_ns,
getter_AddRefs(state));
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
hasMoreData = false;
rv = state->ExecuteStep(&hasMoreData);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
int32_t id;
rv = state->GetInt32(0, &id);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
return id;
}
nsresult DeleteSecurityInfo(mozIStorageConnection& aConn, int32_t aId,
int32_t aCount) {
// First, we need to determine the current refcount for this security blob.
nsCOMPtr<mozIStorageStatement> state;
nsresult rv = aConn.CreateStatement(
"SELECT refcount FROM security_info WHERE id=:id;"_ns,
getter_AddRefs(state));
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
rv = state->BindInt32ByName("id"_ns, aId);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
bool hasMoreData = false;
rv = state->ExecuteStep(&hasMoreData);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
int32_t refcount = -1;
rv = state->GetInt32(0, &refcount);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
MOZ_DIAGNOSTIC_ASSERT(refcount >= aCount);
// Next, calculate the new refcount
int32_t newCount = refcount - aCount;
// If the last reference to this security blob was removed we can
// just remove the entire row.
if (newCount == 0) {
rv = aConn.CreateStatement("DELETE FROM security_info WHERE id=:id;"_ns,
getter_AddRefs(state));
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
rv = state->BindInt32ByName("id"_ns, aId);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
rv = state->Execute();
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
return NS_OK;
}
// Otherwise update the refcount in the table to reflect the reduced
// number of references to the security blob.
rv = aConn.CreateStatement(
nsLiteralCString(
"UPDATE security_info SET refcount=:refcount WHERE id=:id;"),
getter_AddRefs(state));
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
rv = state->BindInt32ByName("refcount"_ns, newCount);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
rv = state->BindInt32ByName("id"_ns, aId);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
rv = state->Execute();
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
return NS_OK;
}
nsresult DeleteSecurityInfoList(
mozIStorageConnection& aConn,
const nsTArray<IdCount>& aDeletedStorageIdList) {
for (const auto& deletedStorageId : aDeletedStorageIdList) {
nsresult rv = DeleteSecurityInfo(aConn, deletedStorageId.mId,
deletedStorageId.mCount);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
}
return NS_OK;
}
nsresult InsertEntry(mozIStorageConnection& aConn, CacheId aCacheId,
const CacheRequest& aRequest, const nsID* aRequestBodyId,
const CacheResponse& aResponse,
const nsID* aResponseBodyId) {
MOZ_ASSERT(!NS_IsMainThread());
nsresult rv = NS_OK;
nsCOMPtr<nsICryptoHash> crypto =
do_CreateInstance(NS_CRYPTO_HASH_CONTRACTID, &rv);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
int32_t securityId = -1;
if (!aResponse.channelInfo().securityInfo().IsEmpty()) {
CACHE_TRY_VAR(securityId,
InsertSecurityInfo(aConn, *crypto,
aResponse.channelInfo().securityInfo()));
}
nsCOMPtr<mozIStorageStatement> state;
rv = aConn.CreateStatement(nsLiteralCString("INSERT INTO entries ("
"request_method, "
"request_url_no_query, "
"request_url_no_query_hash, "
"request_url_query, "
"request_url_query_hash, "
"request_url_fragment, "
"request_referrer, "
"request_referrer_policy, "
"request_headers_guard, "
"request_mode, "
"request_credentials, "
"request_contentpolicytype, "
"request_cache, "
"request_redirect, "
"request_integrity, "
"request_body_id, "
"response_type, "
"response_status, "
"response_status_text, "
"response_headers_guard, "
"response_body_id, "
"response_security_info_id, "
"response_principal_info, "
"response_padding_size, "
"cache_id "
") VALUES ("
":request_method, "
":request_url_no_query, "
":request_url_no_query_hash, "
":request_url_query, "
":request_url_query_hash, "
":request_url_fragment, "
":request_referrer, "
":request_referrer_policy, "
":request_headers_guard, "
":request_mode, "
":request_credentials, "
":request_contentpolicytype, "
":request_cache, "
":request_redirect, "
":request_integrity, "
":request_body_id, "
":response_type, "
":response_status, "
":response_status_text, "
":response_headers_guard, "
":response_body_id, "
":response_security_info_id, "
":response_principal_info, "
":response_padding_size, "
":cache_id "
");"),
getter_AddRefs(state));
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
rv = state->BindUTF8StringByName("request_method"_ns, aRequest.method());
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
rv = state->BindUTF8StringByName("request_url_no_query"_ns,
aRequest.urlWithoutQuery());
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
CACHE_TRY_VAR(const auto urlWithoutQueryHash,
HashCString(*crypto, aRequest.urlWithoutQuery()));
rv = state->BindUTF8StringAsBlobByName("request_url_no_query_hash"_ns,
urlWithoutQueryHash);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
rv = state->BindUTF8StringByName("request_url_query"_ns, aRequest.urlQuery());
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
CACHE_TRY_VAR(const auto urlQueryHash,
HashCString(*crypto, aRequest.urlQuery()));
rv = state->BindUTF8StringAsBlobByName("request_url_query_hash"_ns,
urlQueryHash);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
rv = state->BindUTF8StringByName("request_url_fragment"_ns,
aRequest.urlFragment());
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
rv = state->BindStringByName("request_referrer"_ns, aRequest.referrer());
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
rv = state->BindInt32ByName("request_referrer_policy"_ns,
static_cast<int32_t>(aRequest.referrerPolicy()));
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
rv = state->BindInt32ByName("request_headers_guard"_ns,
static_cast<int32_t>(aRequest.headersGuard()));
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
rv = state->BindInt32ByName("request_mode"_ns,
static_cast<int32_t>(aRequest.mode()));
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
rv = state->BindInt32ByName("request_credentials"_ns,
static_cast<int32_t>(aRequest.credentials()));
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
rv = state->BindInt32ByName(
"request_contentpolicytype"_ns,
static_cast<int32_t>(aRequest.contentPolicyType()));
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
rv = state->BindInt32ByName("request_cache"_ns,
static_cast<int32_t>(aRequest.requestCache()));
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
rv = state->BindInt32ByName("request_redirect"_ns,
static_cast<int32_t>(aRequest.requestRedirect()));
rv = state->BindStringByName("request_integrity"_ns, aRequest.integrity());
rv = BindId(*state, "request_body_id"_ns, aRequestBodyId);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
rv = state->BindInt32ByName("response_type"_ns,
static_cast<int32_t>(aResponse.type()));
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
rv = state->BindInt32ByName("response_status"_ns, aResponse.status());
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
rv = state->BindUTF8StringByName("response_status_text"_ns,
aResponse.statusText());
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
rv = state->BindInt32ByName("response_headers_guard"_ns,
static_cast<int32_t>(aResponse.headersGuard()));
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
rv = BindId(*state, "response_body_id"_ns, aResponseBodyId);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
if (aResponse.channelInfo().securityInfo().IsEmpty()) {
rv = state->BindNullByName("response_security_info_id"_ns);
} else {
rv = state->BindInt32ByName("response_security_info_id"_ns, securityId);
}
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
nsAutoCString serializedInfo;
// We only allow content serviceworkers right now.
if (aResponse.principalInfo().isSome()) {
const mozilla::ipc::PrincipalInfo& principalInfo =
aResponse.principalInfo().ref();
MOZ_DIAGNOSTIC_ASSERT(principalInfo.type() ==
mozilla::ipc::PrincipalInfo::TContentPrincipalInfo);
const mozilla::ipc::ContentPrincipalInfo& cInfo =
principalInfo.get_ContentPrincipalInfo();
serializedInfo.Append(cInfo.spec());
nsAutoCString suffix;
cInfo.attrs().CreateSuffix(suffix);
serializedInfo.Append(suffix);
}
rv =
state->BindUTF8StringByName("response_principal_info"_ns, serializedInfo);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
if (aResponse.paddingSize() == InternalResponse::UNKNOWN_PADDING_SIZE) {
MOZ_DIAGNOSTIC_ASSERT(aResponse.type() != ResponseType::Opaque);
rv = state->BindNullByName("response_padding_size"_ns);
} else {
MOZ_DIAGNOSTIC_ASSERT(aResponse.paddingSize() >= 0);
MOZ_DIAGNOSTIC_ASSERT(aResponse.type() == ResponseType::Opaque);
rv = state->BindInt64ByName("response_padding_size"_ns,
aResponse.paddingSize());
}
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
rv = state->BindInt64ByName("cache_id"_ns, aCacheId);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
rv = state->Execute();
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
rv = aConn.CreateStatement("SELECT last_insert_rowid()"_ns,
getter_AddRefs(state));
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
bool hasMoreData = false;
rv = state->ExecuteStep(&hasMoreData);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
int32_t entryId;
rv = state->GetInt32(0, &entryId);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
rv = aConn.CreateStatement(
nsLiteralCString("INSERT INTO request_headers ("
"name, "
"value, "
"entry_id "
") VALUES (:name, :value, :entry_id)"),
getter_AddRefs(state));
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
for (const auto& requestHeader : aRequest.headers()) {
rv = state->BindUTF8StringByName("name"_ns, requestHeader.name());
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
rv = state->BindUTF8StringByName("value"_ns, requestHeader.value());
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
rv = state->BindInt32ByName("entry_id"_ns, entryId);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
rv = state->Execute();
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
}
rv = aConn.CreateStatement(
nsLiteralCString("INSERT INTO response_headers ("
"name, "
"value, "
"entry_id "
") VALUES (:name, :value, :entry_id)"),
getter_AddRefs(state));
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
for (const auto& responseHeader : aResponse.headers()) {
rv = state->BindUTF8StringByName("name"_ns, responseHeader.name());
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
rv = state->BindUTF8StringByName("value"_ns, responseHeader.value());
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
rv = state->BindInt32ByName("entry_id"_ns, entryId);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
rv = state->Execute();
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
}
rv = aConn.CreateStatement(nsLiteralCString("INSERT INTO response_url_list ("
"url, "
"entry_id "
") VALUES (:url, :entry_id)"),
getter_AddRefs(state));
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
for (const auto& responseUrl : aResponse.urlList()) {
rv = state->BindUTF8StringByName("url"_ns, responseUrl);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
rv = state->BindInt32ByName("entry_id"_ns, entryId);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
rv = state->Execute();
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
}
return rv;
}
Result<SavedResponse, nsresult> ReadResponse(mozIStorageConnection& aConn,
EntryId aEntryId) {
MOZ_ASSERT(!NS_IsMainThread());
SavedResponse savedResponse;
nsCOMPtr<mozIStorageStatement> state;
nsresult rv = aConn.CreateStatement(
nsLiteralCString("SELECT "
"entries.response_type, "
"entries.response_status, "
"entries.response_status_text, "
"entries.response_headers_guard, "
"entries.response_body_id, "
"entries.response_principal_info, "
"entries.response_padding_size, "
"security_info.data "
"FROM entries "
"LEFT OUTER JOIN security_info "
"ON entries.response_security_info_id=security_info.id "
"WHERE entries.id=:id;"),
getter_AddRefs(state));
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
rv = state->BindInt32ByName("id"_ns, aEntryId);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
bool hasMoreData = false;
rv = state->ExecuteStep(&hasMoreData);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
int32_t type;
rv = state->GetInt32(0, &type);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
savedResponse.mValue.type() = static_cast<ResponseType>(type);
int32_t status;
rv = state->GetInt32(1, &status);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
savedResponse.mValue.status() = status;
rv = state->GetUTF8String(2, savedResponse.mValue.statusText());
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
int32_t guard;
rv = state->GetInt32(3, &guard);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
savedResponse.mValue.headersGuard() = static_cast<HeadersGuardEnum>(guard);
bool nullBody = false;
rv = state->GetIsNull(4, &nullBody);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
savedResponse.mHasBodyId = !nullBody;
if (savedResponse.mHasBodyId) {
CACHE_TRY_VAR(savedResponse.mBodyId, ExtractId(*state, 4));
}
nsAutoCString serializedInfo;
rv = state->GetUTF8String(5, serializedInfo);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
savedResponse.mValue.principalInfo() = Nothing();
if (!serializedInfo.IsEmpty()) {
nsAutoCString specNoSuffix;
OriginAttributes attrs;
if (!attrs.PopulateFromOrigin(serializedInfo, specNoSuffix)) {
NS_WARNING("Something went wrong parsing a serialized principal!");
return Err(NS_ERROR_FAILURE);
}
RefPtr<net::MozURL> url;
rv = net::MozURL::Init(getter_AddRefs(url), specNoSuffix);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
#ifdef DEBUG
nsDependentCSubstring scheme = url->Scheme();
MOZ_ASSERT(
scheme == "http" || scheme == "https" || scheme == "file" ||
(StaticPrefs::extensions_backgroundServiceWorker_enabled_AtStartup() &&
scheme == "moz-extension"));
#endif
nsCString origin;
url->Origin(origin);
nsCString baseDomain;
rv = url->BaseDomain(baseDomain);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
savedResponse.mValue.principalInfo() =
Some(mozilla::ipc::ContentPrincipalInfo(attrs, origin, specNoSuffix,
Nothing(), baseDomain));
}
bool nullPadding = false;
rv = state->GetIsNull(6, &nullPadding);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
if (nullPadding) {
MOZ_DIAGNOSTIC_ASSERT(savedResponse.mValue.type() != ResponseType::Opaque);
savedResponse.mValue.paddingSize() = InternalResponse::UNKNOWN_PADDING_SIZE;
} else {
MOZ_DIAGNOSTIC_ASSERT(savedResponse.mValue.type() == ResponseType::Opaque);
int64_t paddingSize = 0;
rv = state->GetInt64(6, &paddingSize);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
MOZ_DIAGNOSTIC_ASSERT(paddingSize >= 0);
savedResponse.mValue.paddingSize() = paddingSize;
}
rv = state->GetBlobAsUTF8String(
7, savedResponse.mValue.channelInfo().securityInfo());
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
rv = aConn.CreateStatement(nsLiteralCString("SELECT "
"name, "
"value "
"FROM response_headers "
"WHERE entry_id=:entry_id;"),
getter_AddRefs(state));
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
rv = state->BindInt32ByName("entry_id"_ns, aEntryId);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
while (NS_SUCCEEDED(state->ExecuteStep(&hasMoreData)) && hasMoreData) {
HeadersEntry header;
rv = state->GetUTF8String(0, header.name());
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
rv = state->GetUTF8String(1, header.value());
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
savedResponse.mValue.headers().AppendElement(header);
}
rv = aConn.CreateStatement(nsLiteralCString("SELECT "
"url "
"FROM response_url_list "
"WHERE entry_id=:entry_id;"),
getter_AddRefs(state));
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
rv = state->BindInt32ByName("entry_id"_ns, aEntryId);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
while (NS_SUCCEEDED(state->ExecuteStep(&hasMoreData)) && hasMoreData) {
nsCString url;
rv = state->GetUTF8String(0, url);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
savedResponse.mValue.urlList().AppendElement(url);
}
return savedResponse;
}
Result<SavedRequest, nsresult> ReadRequest(mozIStorageConnection& aConn,
EntryId aEntryId) {
MOZ_ASSERT(!NS_IsMainThread());
SavedRequest savedRequest;
nsCOMPtr<mozIStorageStatement> state;
nsresult rv =
aConn.CreateStatement(nsLiteralCString("SELECT "
"request_method, "
"request_url_no_query, "
"request_url_query, "
"request_url_fragment, "
"request_referrer, "
"request_referrer_policy, "
"request_headers_guard, "
"request_mode, "
"request_credentials, "
"request_contentpolicytype, "
"request_cache, "
"request_redirect, "
"request_integrity, "
"request_body_id "
"FROM entries "
"WHERE id=:id;"),
getter_AddRefs(state));
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
rv = state->BindInt32ByName("id"_ns, aEntryId);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
bool hasMoreData = false;
rv = state->ExecuteStep(&hasMoreData);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
rv = state->GetUTF8String(0, savedRequest.mValue.method());
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
rv = state->GetUTF8String(1, savedRequest.mValue.urlWithoutQuery());
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
rv = state->GetUTF8String(2, savedRequest.mValue.urlQuery());
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
rv = state->GetUTF8String(3, savedRequest.mValue.urlFragment());
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
rv = state->GetString(4, savedRequest.mValue.referrer());
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
int32_t referrerPolicy;
rv = state->GetInt32(5, &referrerPolicy);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
savedRequest.mValue.referrerPolicy() =
static_cast<ReferrerPolicy>(referrerPolicy);
int32_t guard;
rv = state->GetInt32(6, &guard);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
savedRequest.mValue.headersGuard() = static_cast<HeadersGuardEnum>(guard);
int32_t mode;
rv = state->GetInt32(7, &mode);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
savedRequest.mValue.mode() = static_cast<RequestMode>(mode);
int32_t credentials;
rv = state->GetInt32(8, &credentials);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
savedRequest.mValue.credentials() =
static_cast<RequestCredentials>(credentials);
int32_t requestContentPolicyType;
rv = state->GetInt32(9, &requestContentPolicyType);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
savedRequest.mValue.contentPolicyType() =
static_cast<nsContentPolicyType>(requestContentPolicyType);
int32_t requestCache;
rv = state->GetInt32(10, &requestCache);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
savedRequest.mValue.requestCache() = static_cast<RequestCache>(requestCache);
int32_t requestRedirect;
rv = state->GetInt32(11, &requestRedirect);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
savedRequest.mValue.requestRedirect() =
static_cast<RequestRedirect>(requestRedirect);
rv = state->GetString(12, savedRequest.mValue.integrity());
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
bool nullBody = false;
rv = state->GetIsNull(13, &nullBody);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
savedRequest.mHasBodyId = !nullBody;
if (savedRequest.mHasBodyId) {
CACHE_TRY_VAR(savedRequest.mBodyId, ExtractId(*state, 13));
}
rv = aConn.CreateStatement(nsLiteralCString("SELECT "
"name, "
"value "
"FROM request_headers "
"WHERE entry_id=:entry_id;"),
getter_AddRefs(state));
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
rv = state->BindInt32ByName("entry_id"_ns, aEntryId);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
while (NS_SUCCEEDED(state->ExecuteStep(&hasMoreData)) && hasMoreData) {
HeadersEntry header;
rv = state->GetUTF8String(0, header.name());
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
rv = state->GetUTF8String(1, header.value());
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
savedRequest.mValue.headers().AppendElement(header);
}
return savedRequest;
}
void AppendListParamsToQuery(nsACString& aQuery,
const nsTArray<EntryId>& aEntryIdList,
uint32_t aPos, int32_t aLen) {
MOZ_ASSERT(!NS_IsMainThread());
MOZ_DIAGNOSTIC_ASSERT((aPos + aLen) <= aEntryIdList.Length());
for (int32_t i = aPos; i < aLen; ++i) {
if (i == 0) {
aQuery.AppendLiteral("?");
} else {
aQuery.AppendLiteral(",?");
}
}
}
nsresult BindListParamsToQuery(mozIStorageStatement& aState,
const nsTArray<EntryId>& aEntryIdList,
uint32_t aPos, int32_t aLen) {
MOZ_ASSERT(!NS_IsMainThread());
MOZ_DIAGNOSTIC_ASSERT((aPos + aLen) <= aEntryIdList.Length());
for (int32_t i = aPos; i < aLen; ++i) {
CACHE_TRY(aState.BindInt32ByIndex(i, aEntryIdList[i]));
}
return NS_OK;
}
nsresult BindId(mozIStorageStatement& aState, const nsACString& aName,
const nsID* aId) {
MOZ_ASSERT(!NS_IsMainThread());
nsresult rv;
if (!aId) {
rv = aState.BindNullByName(aName);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
return rv;
}
char idBuf[NSID_LENGTH];
aId->ToProvidedString(idBuf);
rv = aState.BindUTF8StringByName(aName, nsDependentCString(idBuf));
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
return rv;
}
Result<nsID, nsresult> ExtractId(mozIStorageStatement& aState, uint32_t aPos) {
MOZ_ASSERT(!NS_IsMainThread());
nsAutoCString idString;
nsresult rv = aState.GetUTF8String(aPos, idString);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
nsID id;
bool success = id.Parse(idString.get());
if (NS_WARN_IF(!success)) {
return Err(NS_ERROR_UNEXPECTED);
}
return id;
}
Result<MovingNotNull<nsCOMPtr<mozIStorageStatement>>, nsresult>
CreateAndBindKeyStatement(mozIStorageConnection& aConn,
const char* aQueryFormat, const nsAString& aKey) {
MOZ_DIAGNOSTIC_ASSERT(aQueryFormat);
// The key is stored as a blob to avoid encoding issues. An empty string
// is mapped to NULL for blobs. Normally we would just write the query
// as "key IS :key" to do the proper NULL checking, but that prevents
// sqlite from using the key index. Therefore use "IS NULL" explicitly
// if the key is empty, otherwise use "=:key" so that sqlite uses the
// index.
const char* constraint = nullptr;
if (aKey.IsEmpty()) {
constraint = "key IS NULL";
} else {
constraint = "key=:key";
}
nsPrintfCString query(aQueryFormat, constraint);
nsCOMPtr<mozIStorageStatement> state;
nsresult rv = aConn.CreateStatement(query, getter_AddRefs(state));
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
if (!aKey.IsEmpty()) {
rv = state->BindStringAsBlobByName("key"_ns, aKey);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
}
return WrapMovingNotNull(std::move(state));
}
Result<nsAutoCString, nsresult> HashCString(nsICryptoHash& aCrypto,
const nsACString& aIn) {
nsresult rv = aCrypto.Init(nsICryptoHash::SHA1);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
rv = aCrypto.Update(reinterpret_cast<const uint8_t*>(aIn.BeginReading()),
aIn.Length());
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
nsAutoCString fullHash;
rv = aCrypto.Finish(false /* based64 result */, fullHash);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
return Result<nsAutoCString, nsresult>{std::in_place,
Substring(fullHash, 0, 8)};
}
} // namespace
nsresult IncrementalVacuum(mozIStorageConnection& aConn) {
// Determine how much free space is in the database.
nsCOMPtr<mozIStorageStatement> state;
nsresult rv =
aConn.CreateStatement("PRAGMA freelist_count;"_ns, getter_AddRefs(state));
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
bool hasMoreData = false;
rv = state->ExecuteStep(&hasMoreData);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
int32_t freePages = 0;
rv = state->GetInt32(0, &freePages);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
// We have a relatively small page size, so we want to be careful to avoid
// fragmentation. We already use a growth incremental which will cause
// sqlite to allocate and release multiple pages at the same time. We can
// further reduce fragmentation by making our allocated chunks a bit
// "sticky". This is done by creating some hysteresis where we allocate
// pages/chunks as soon as we need them, but we only release pages/chunks
// when we have a large amount of free space. This helps with the case
// where a page is adding and remove resources causing it to dip back and
// forth across a chunk boundary.
//
// So only proceed with releasing pages if we have more than our constant
// threshold.
if (freePages <= kMaxFreePages) {
return NS_OK;
}
// Release the excess pages back to the sqlite VFS. This may also release
// chunks of multiple pages back to the OS.
int32_t pagesToRelease = freePages - kMaxFreePages;
rv = aConn.ExecuteSimpleSQL(
nsPrintfCString("PRAGMA incremental_vacuum(%d);", pagesToRelease));
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
// Verify that our incremental vacuum actually did something
#ifdef DEBUG
rv =
aConn.CreateStatement("PRAGMA freelist_count;"_ns, getter_AddRefs(state));
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
hasMoreData = false;
rv = state->ExecuteStep(&hasMoreData);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
freePages = 0;
rv = state->GetInt32(0, &freePages);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
MOZ_ASSERT(freePages <= kMaxFreePages);
#endif
return NS_OK;
}
namespace {
// Wrapper around mozIStorageConnection::GetSchemaVersion() that compensates
// for hacky downgrade schema version tricks. See the block comments for
// kHackyDowngradeSchemaVersion and kHackyPaddingSizePresentVersion.
Result<int32_t, nsresult> GetEffectiveSchemaVersion(
mozIStorageConnection& aConn) {
int32_t schemaVersion;
nsresult rv = aConn.GetSchemaVersion(&schemaVersion);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
if (schemaVersion == kHackyDowngradeSchemaVersion) {
// This is the special case. Check for the existence of the
// "response_padding_size" colum in table "entries".
//
// (pragma_table_info is a table-valued function format variant of
// "PRAGMA table_info" supported since SQLite 3.16.0. Firefox 53 shipped
// was the first release with this functionality, shipping 3.16.2.)
nsCOMPtr<mozIStorageStatement> stmt;
rv = aConn.CreateStatement(
nsLiteralCString("SELECT name FROM pragma_table_info('entries') WHERE "
"name = 'response_padding_size'"),
getter_AddRefs(stmt));
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
// If there are any result rows, then the column is present.
bool hasColumn = false;
rv = stmt->ExecuteStep(&hasColumn);
if (NS_WARN_IF(NS_FAILED(rv))) {
return Err(rv);
}
if (hasColumn) {
return kHackyPaddingSizePresentVersion;
}
}
return schemaVersion;
}
#ifdef DEBUG
struct Expect {
// Expect exact SQL
Expect(const char* aName, const char* aType, const char* aSql)
: mName(aName), mType(aType), mSql(aSql), mIgnoreSql(false) {}
// Ignore SQL
Expect(const char* aName, const char* aType)
: mName(aName), mType(aType), mIgnoreSql(true) {}
const nsCString mName;
const nsCString mType;
const nsCString mSql;
const bool mIgnoreSql;
};
#endif
nsresult Validate(mozIStorageConnection& aConn) {
int32_t schemaVersion;
CACHE_TRY_VAR(schemaVersion, GetEffectiveSchemaVersion(aConn));
if (NS_WARN_IF(schemaVersion != kLatestSchemaVersion)) {
return NS_ERROR_FAILURE;
}
#ifdef DEBUG
// This is the schema we expect the database at the latest version to
// contain. Update this list if you add a new table or index.
Expect expects[] = {
Expect("caches", "table", kTableCaches),
Expect("sqlite_sequence", "table"), // auto-gen by sqlite
Expect("security_info", "table", kTableSecurityInfo),
Expect("security_info_hash_index", "index", kIndexSecurityInfoHash),
Expect("entries", "table", kTableEntries),
Expect("entries_request_match_index", "index", kIndexEntriesRequest),
Expect("request_headers", "table", kTableRequestHeaders),
Expect("response_headers", "table", kTableResponseHeaders),
Expect("response_headers_name_index", "index", kIndexResponseHeadersName),
Expect("response_url_list", "table", kTableResponseUrlList),
Expect("storage", "table", kTableStorage),
Expect("sqlite_autoindex_storage_1", "index"), // auto-gen by sqlite
};
// Read the schema from the sqlite_master table and compare.
nsCOMPtr<mozIStorageStatement> state;
nsresult rv = aConn.CreateStatement(
"SELECT name, type, sql FROM sqlite_master;"_ns, getter_AddRefs(state));
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
bool hasMoreData = false;
while (NS_SUCCEEDED(state->ExecuteStep(&hasMoreData)) && hasMoreData) {
nsAutoCString name;
rv = state->GetUTF8String(0, name);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
nsAutoCString type;
rv = state->GetUTF8String(1, type);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
nsAutoCString sql;
rv = state->GetUTF8String(2, sql);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
bool foundMatch = false;
for (const auto& expect : expects) {
if (name == expect.mName) {
if (type != expect.mType) {
NS_WARNING(
nsPrintfCString("Unexpected type for Cache schema entry %s",
name.get())
.get());
return NS_ERROR_FAILURE;
}
if (!expect.mIgnoreSql && sql != expect.mSql) {
NS_WARNING(nsPrintfCString("Unexpected SQL for Cache schema entry %s",
name.get())
.get());
return NS_ERROR_FAILURE;
}
foundMatch = true;
break;
}
}
if (NS_WARN_IF(!foundMatch)) {
NS_WARNING(nsPrintfCString("Unexpected schema entry %s in Cache database",
name.get())
.get());
return NS_ERROR_FAILURE;
}
}
#endif
return NS_OK;
}
// -----
// Schema migration code
// -----
typedef nsresult (*MigrationFunc)(mozIStorageConnection&, bool&);
struct Migration {
constexpr Migration(int32_t aFromVersion, MigrationFunc aFunc)
: mFromVersion(aFromVersion), mFunc(aFunc) {}
int32_t mFromVersion;
MigrationFunc mFunc;
};
// Declare migration functions here. Each function should upgrade
// the version by a single increment. Don't skip versions.
nsresult MigrateFrom15To16(mozIStorageConnection& aConn, bool& aRewriteSchema);
nsresult MigrateFrom16To17(mozIStorageConnection& aConn, bool& aRewriteSchema);
nsresult MigrateFrom17To18(mozIStorageConnection& aConn, bool& aRewriteSchema);
nsresult MigrateFrom18To19(mozIStorageConnection& aConn, bool& aRewriteSchema);
nsresult MigrateFrom19To20(mozIStorageConnection& aConn, bool& aRewriteSchema);
nsresult MigrateFrom20To21(mozIStorageConnection& aConn, bool& aRewriteSchema);
nsresult MigrateFrom21To22(mozIStorageConnection& aConn, bool& aRewriteSchema);
nsresult MigrateFrom22To23(mozIStorageConnection& aConn, bool& aRewriteSchema);
nsresult MigrateFrom23To24(mozIStorageConnection& aConn, bool& aRewriteSchema);
nsresult MigrateFrom24To25(mozIStorageConnection& aConn, bool& aRewriteSchema);
nsresult MigrateFrom25To26(mozIStorageConnection& aConn, bool& aRewriteSchema);
nsresult MigrateFrom26To27(mozIStorageConnection& aConn, bool& aRewriteSchema);
// Configure migration functions to run for the given starting version.
Migration sMigrationList[] = {
Migration(15, MigrateFrom15To16), Migration(16, MigrateFrom16To17),
Migration(17, MigrateFrom17To18), Migration(18, MigrateFrom18To19),
Migration(19, MigrateFrom19To20), Migration(20, MigrateFrom20To21),
Migration(21, MigrateFrom21To22), Migration(22, MigrateFrom22To23),
Migration(23, MigrateFrom23To24), Migration(24, MigrateFrom24To25),
Migration(25, MigrateFrom25To26), Migration(26, MigrateFrom26To27),
};
nsresult RewriteEntriesSchema(mozIStorageConnection& aConn) {
nsresult rv = aConn.ExecuteSimpleSQL("PRAGMA writable_schema = ON"_ns);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
nsCOMPtr<mozIStorageStatement> state;
rv = aConn.CreateStatement(
nsLiteralCString(
"UPDATE sqlite_master SET sql=:sql WHERE name='entries'"),
getter_AddRefs(state));
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
rv = state->BindUTF8StringByName("sql"_ns, nsDependentCString(kTableEntries));
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
rv = state->Execute();
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
rv = aConn.ExecuteSimpleSQL("PRAGMA writable_schema = OFF"_ns);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
return rv;
}
nsresult Migrate(mozIStorageConnection& aConn) {
MOZ_ASSERT(!NS_IsMainThread());
int32_t currentVersion = 0;
CACHE_TRY_VAR(currentVersion, GetEffectiveSchemaVersion(aConn));
bool rewriteSchema = false;
while (currentVersion < kLatestSchemaVersion) {
// Wiping old databases is handled in DBAction because it requires
// making a whole new mozIStorageConnection. Make sure we don't
// accidentally get here for one of those old databases.
MOZ_DIAGNOSTIC_ASSERT(currentVersion >= kFirstShippedSchemaVersion);
for (const auto& migration : sMigrationList) {
if (migration.mFromVersion == currentVersion) {
bool shouldRewrite = false;
nsresult rv = migration.mFunc(aConn, shouldRewrite);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
if (shouldRewrite) {
rewriteSchema = true;
}
break;
}
}
#ifdef MOZ_DIAGNOSTIC_ASSERT_ENABLED
int32_t lastVersion = currentVersion;
#endif
CACHE_TRY_VAR(currentVersion, GetEffectiveSchemaVersion(aConn));
MOZ_DIAGNOSTIC_ASSERT(currentVersion > lastVersion);
}
// Don't release assert this since people do sometimes share profiles
// across schema versions. Our check in Validate() will catch it.
MOZ_ASSERT(currentVersion == kLatestSchemaVersion);
nsresult rv = NS_OK;
if (rewriteSchema) {
// Now overwrite the master SQL for the entries table to remove the column
// default value. This is also necessary for our Validate() method to
// pass on this database.
rv = RewriteEntriesSchema(aConn);
}
return rv;
}
nsresult MigrateFrom15To16(mozIStorageConnection& aConn, bool& aRewriteSchema) {
MOZ_ASSERT(!NS_IsMainThread());
// Add the request_redirect column with a default value of "follow". Note,
// we only use a default value here because its required by ALTER TABLE and
// we need to apply the default "follow" to existing records in the table.
// We don't actually want to keep the default in the schema for future
// INSERTs.
nsresult rv = aConn.ExecuteSimpleSQL(nsLiteralCString(
"ALTER TABLE entries "
"ADD COLUMN request_redirect INTEGER NOT NULL DEFAULT 0"));
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
rv = aConn.SetSchemaVersion(16);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
aRewriteSchema = true;
return rv;
}
nsresult MigrateFrom16To17(mozIStorageConnection& aConn, bool& aRewriteSchema) {
MOZ_ASSERT(!NS_IsMainThread());
// This migration path removes the response_redirected and
// response_redirected_url columns from the entries table. sqlite doesn't
// support removing a column from a table using ALTER TABLE, so we need to
// create a new table without those columns, fill it up with the existing
// data, and then drop the original table and rename the new one to the old
// one.
// Create a new_entries table with the new fields as of version 17.
nsresult rv = aConn.ExecuteSimpleSQL(nsLiteralCString(
"CREATE TABLE new_entries ("
"id INTEGER NOT NULL PRIMARY KEY, "
"request_method TEXT NOT NULL, "
"request_url_no_query TEXT NOT NULL, "
"request_url_no_query_hash BLOB NOT NULL, "
"request_url_query TEXT NOT NULL, "
"request_url_query_hash BLOB NOT NULL, "
"request_referrer TEXT NOT NULL, "
"request_headers_guard INTEGER NOT NULL, "
"request_mode INTEGER NOT NULL, "
"request_credentials INTEGER NOT NULL, "
"request_contentpolicytype INTEGER NOT NULL, "
"request_cache INTEGER NOT NULL, "
"request_body_id TEXT NULL, "
"response_type INTEGER NOT NULL, "
"response_url TEXT NOT NULL, "
"response_status INTEGER NOT NULL, "
"response_status_text TEXT NOT NULL, "
"response_headers_guard INTEGER NOT NULL, "
"response_body_id TEXT NULL, "
"response_security_info_id INTEGER NULL REFERENCES security_info(id), "
"response_principal_info TEXT NOT NULL, "
"cache_id INTEGER NOT NULL REFERENCES caches(id) ON DELETE CASCADE, "
"request_redirect INTEGER NOT NULL"
")"));
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
// Copy all of the data to the newly created table.
rv =
aConn.ExecuteSimpleSQL(nsLiteralCString("INSERT INTO new_entries ("
"id, "
"request_method, "
"request_url_no_query, "
"request_url_no_query_hash, "
"request_url_query, "
"request_url_query_hash, "
"request_referrer, "
"request_headers_guard, "
"request_mode, "
"request_credentials, "
"request_contentpolicytype, "
"request_cache, "
"request_redirect, "
"request_body_id, "
"response_type, "
"response_url, "
"response_status, "
"response_status_text, "
"response_headers_guard, "
"response_body_id, "
"response_security_info_id, "
"response_principal_info, "
"cache_id "
") SELECT "
"id, "
"request_method, "
"request_url_no_query, "
"request_url_no_query_hash, "
"request_url_query, "
"request_url_query_hash, "
"request_referrer, "
"request_headers_guard, "
"request_mode, "
"request_credentials, "
"request_contentpolicytype, "
"request_cache, "
"request_redirect, "
"request_body_id, "
"response_type, "
"response_url, "
"response_status, "
"response_status_text, "
"response_headers_guard, "
"response_body_id, "
"response_security_info_id, "
"response_principal_info, "
"cache_id "
"FROM entries;"));
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
// Remove the old table.
rv = aConn.ExecuteSimpleSQL("DROP TABLE entries;"_ns);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
// Rename new_entries to entries.
rv = aConn.ExecuteSimpleSQL("ALTER TABLE new_entries RENAME to entries;"_ns);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
// Now, recreate our indices.
rv = aConn.ExecuteSimpleSQL(nsDependentCString(kIndexEntriesRequest));
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
// Revalidate the foreign key constraints, and ensure that there are no
// violations.
nsCOMPtr<mozIStorageStatement> state;
rv = aConn.CreateStatement("PRAGMA foreign_key_check;"_ns,
getter_AddRefs(state));
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
bool hasMoreData = false;
rv = state->ExecuteStep(&hasMoreData);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
if (NS_WARN_IF(hasMoreData)) {
return NS_ERROR_FAILURE;
}
rv = aConn.SetSchemaVersion(17);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
return rv;
}
nsresult MigrateFrom17To18(mozIStorageConnection& aConn, bool& aRewriteSchema) {
MOZ_ASSERT(!NS_IsMainThread());
// This migration is needed in order to remove "only-if-cached" RequestCache
// values from the database. This enum value was removed from the spec in
// https://github.com/whatwg/fetch/issues/39 but we unfortunately happily
// accepted this value in the Request constructor.
//
// There is no good value to upgrade this to, so we just stick to "default".
static_assert(int(RequestCache::Default) == 0,
"This is where the 0 below comes from!");
nsresult rv = aConn.ExecuteSimpleSQL(
nsLiteralCString("UPDATE entries SET request_cache = 0 "
"WHERE request_cache = 5;"));
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
rv = aConn.SetSchemaVersion(18);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
return rv;
}
nsresult MigrateFrom18To19(mozIStorageConnection& aConn, bool& aRewriteSchema) {
MOZ_ASSERT(!NS_IsMainThread());
// This migration is needed in order to update the RequestMode values for
// Request objects corresponding to a navigation content policy type to
// "navigate".
static_assert(int(nsIContentPolicy::TYPE_DOCUMENT) == 6 &&
int(nsIContentPolicy::TYPE_SUBDOCUMENT) == 7 &&
int(nsIContentPolicy::TYPE_INTERNAL_FRAME) == 28 &&
int(nsIContentPolicy::TYPE_INTERNAL_IFRAME) == 29 &&
int(nsIContentPolicy::TYPE_REFRESH) == 8 &&
int(RequestMode::Navigate) == 3,
"This is where the numbers below come from!");
nsresult rv = aConn.ExecuteSimpleSQL(nsLiteralCString(
"UPDATE entries SET request_mode = 3 "
"WHERE request_contentpolicytype IN (6, 7, 28, 29, 8);"));
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
rv = aConn.SetSchemaVersion(19);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
return rv;
}
nsresult MigrateFrom19To20(mozIStorageConnection& aConn, bool& aRewriteSchema) {
MOZ_ASSERT(!NS_IsMainThread());
// Add the request_referrer_policy column with a default value of
// "no-referrer-when-downgrade". Note, we only use a default value here
// because its required by ALTER TABLE and we need to apply the default
// "no-referrer-when-downgrade" to existing records in the table. We don't
// actually want to keep the default in the schema for future INSERTs.
nsresult rv = aConn.ExecuteSimpleSQL(nsLiteralCString(
"ALTER TABLE entries "
"ADD COLUMN request_referrer_policy INTEGER NOT NULL DEFAULT 2"));
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
rv = aConn.SetSchemaVersion(20);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
aRewriteSchema = true;
return rv;
}
nsresult MigrateFrom20To21(mozIStorageConnection& aConn, bool& aRewriteSchema) {
MOZ_ASSERT(!NS_IsMainThread());
// This migration creates response_url_list table to store response_url and
// removes the response_url column from the entries table.
// sqlite doesn't support removing a column from a table using ALTER TABLE,
// so we need to create a new table without those columns, fill it up with the
// existing data, and then drop the original table and rename the new one to
// the old one.
// Create a new_entries table with the new fields as of version 21.
nsresult rv = aConn.ExecuteSimpleSQL(nsLiteralCString(
"CREATE TABLE new_entries ("
"id INTEGER NOT NULL PRIMARY KEY, "
"request_method TEXT NOT NULL, "
"request_url_no_query TEXT NOT NULL, "
"request_url_no_query_hash BLOB NOT NULL, "
"request_url_query TEXT NOT NULL, "
"request_url_query_hash BLOB NOT NULL, "
"request_referrer TEXT NOT NULL, "
"request_headers_guard INTEGER NOT NULL, "
"request_mode INTEGER NOT NULL, "
"request_credentials INTEGER NOT NULL, "
"request_contentpolicytype INTEGER NOT NULL, "
"request_cache INTEGER NOT NULL, "
"request_body_id TEXT NULL, "
"response_type INTEGER NOT NULL, "
"response_status INTEGER NOT NULL, "
"response_status_text TEXT NOT NULL, "
"response_headers_guard INTEGER NOT NULL, "
"response_body_id TEXT NULL, "
"response_security_info_id INTEGER NULL REFERENCES security_info(id), "
"response_principal_info TEXT NOT NULL, "
"cache_id INTEGER NOT NULL REFERENCES caches(id) ON DELETE CASCADE, "
"request_redirect INTEGER NOT NULL, "
"request_referrer_policy INTEGER NOT NULL"
")"));
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
// Create a response_url_list table with the new fields as of version 21.
rv = aConn.ExecuteSimpleSQL(nsLiteralCString(
"CREATE TABLE response_url_list ("
"url TEXT NOT NULL, "
"entry_id INTEGER NOT NULL REFERENCES entries(id) ON DELETE CASCADE"
")"));
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
// Copy all of the data to the newly created entries table.
rv =
aConn.ExecuteSimpleSQL(nsLiteralCString("INSERT INTO new_entries ("
"id, "
"request_method, "
"request_url_no_query, "
"request_url_no_query_hash, "
"request_url_query, "
"request_url_query_hash, "
"request_referrer, "
"request_headers_guard, "
"request_mode, "
"request_credentials, "
"request_contentpolicytype, "
"request_cache, "
"request_redirect, "
"request_referrer_policy, "
"request_body_id, "
"response_type, "
"response_status, "
"response_status_text, "
"response_headers_guard, "
"response_body_id, "
"response_security_info_id, "
"response_principal_info, "
"cache_id "
") SELECT "
"id, "
"request_method, "
"request_url_no_query, "
"request_url_no_query_hash, "
"request_url_query, "
"request_url_query_hash, "
"request_referrer, "
"request_headers_guard, "
"request_mode, "
"request_credentials, "
"request_contentpolicytype, "
"request_cache, "
"request_redirect, "
"request_referrer_policy, "
"request_body_id, "
"response_type, "
"response_status, "
"response_status_text, "
"response_headers_guard, "
"response_body_id, "
"response_security_info_id, "
"response_principal_info, "
"cache_id "
"FROM entries;"));
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
// Copy reponse_url to the newly created response_url_list table.
rv =
aConn.ExecuteSimpleSQL(nsLiteralCString("INSERT INTO response_url_list ("
"url, "
"entry_id "
") SELECT "
"response_url, "
"id "
"FROM entries;"));
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
// Remove the old table.
rv = aConn.ExecuteSimpleSQL("DROP TABLE entries;"_ns);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
// Rename new_entries to entries.
rv = aConn.ExecuteSimpleSQL("ALTER TABLE new_entries RENAME to entries;"_ns);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
// Now, recreate our indices.
rv = aConn.ExecuteSimpleSQL(nsDependentCString(kIndexEntriesRequest));
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
// Revalidate the foreign key constraints, and ensure that there are no
// violations.
nsCOMPtr<mozIStorageStatement> state;
rv = aConn.CreateStatement("PRAGMA foreign_key_check;"_ns,
getter_AddRefs(state));
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
bool hasMoreData = false;
rv = state->ExecuteStep(&hasMoreData);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
if (NS_WARN_IF(hasMoreData)) {
return NS_ERROR_FAILURE;
}
rv = aConn.SetSchemaVersion(21);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
aRewriteSchema = true;
return rv;
}
nsresult MigrateFrom21To22(mozIStorageConnection& aConn, bool& aRewriteSchema) {
MOZ_ASSERT(!NS_IsMainThread());
// Add the request_integrity column.
nsresult rv = aConn.ExecuteSimpleSQL(
nsLiteralCString("ALTER TABLE entries "
"ADD COLUMN request_integrity TEXT NULL"));
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
rv = aConn.SetSchemaVersion(22);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
aRewriteSchema = true;
return rv;
}
nsresult MigrateFrom22To23(mozIStorageConnection& aConn, bool& aRewriteSchema) {
MOZ_ASSERT(!NS_IsMainThread());
// The only change between 22 and 23 was a different snappy compression
// format, but it's backwards-compatible.
nsresult rv = aConn.SetSchemaVersion(23);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
return rv;
}
nsresult MigrateFrom23To24(mozIStorageConnection& aConn, bool& aRewriteSchema) {
MOZ_ASSERT(!NS_IsMainThread());
// Add the request_url_fragment column.
nsresult rv = aConn.ExecuteSimpleSQL(nsLiteralCString(
"ALTER TABLE entries "
"ADD COLUMN request_url_fragment TEXT NOT NULL DEFAULT ''"));
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
rv = aConn.SetSchemaVersion(24);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
aRewriteSchema = true;
return rv;
}
nsresult MigrateFrom24To25(mozIStorageConnection& aConn, bool& aRewriteSchema) {
MOZ_ASSERT(!NS_IsMainThread());
// The only change between 24 and 25 was a new nsIContentPolicy type.
nsresult rv = aConn.SetSchemaVersion(25);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
return rv;
}
nsresult MigrateFrom25To26(mozIStorageConnection& aConn, bool& aRewriteSchema) {
MOZ_ASSERT(!NS_IsMainThread());
// Add the response_padding_size column.
// Note: only opaque repsonse should be non-null interger.
nsresult rv = aConn.ExecuteSimpleSQL(
nsLiteralCString("ALTER TABLE entries "
"ADD COLUMN response_padding_size INTEGER NULL "));
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
rv = aConn.ExecuteSimpleSQL(
nsLiteralCString("UPDATE entries SET response_padding_size = 0 "
"WHERE response_type = 4" // opaque response
));
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
rv = aConn.SetSchemaVersion(26);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
aRewriteSchema = true;
return rv;
}
nsresult MigrateFrom26To27(mozIStorageConnection& aConn, bool& aRewriteSchema) {
MOZ_ASSERT(!NS_IsMainThread());
nsresult rv = aConn.SetSchemaVersion(kHackyDowngradeSchemaVersion);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
return rv;
}
} // anonymous namespace
} // namespace db
} // namespace cache
} // namespace dom
} // namespace mozilla
Ссылка в новой задаче Показать git blame Копировать постоянную ссылку