161 lines
6.7 KiB
C++
161 lines
6.7 KiB
C++
/*
|
|
* Copyright (C) 2008-2017 Apple Inc. All Rights Reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions
|
|
* are met:
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in the
|
|
* documentation and/or other materials provided with the distribution.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
|
|
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
|
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR
|
|
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
|
|
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
|
|
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
|
|
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
|
|
* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include "SecurityOriginHash.h"
|
|
#include "SQLiteDatabase.h"
|
|
#include <wtf/HashCountedSet.h>
|
|
#include <wtf/HashSet.h>
|
|
#include <wtf/text/StringHash.h>
|
|
#include <wtf/text/WTFString.h>
|
|
|
|
namespace WebCore {
|
|
|
|
class ApplicationCache;
|
|
class ApplicationCacheGroup;
|
|
class ApplicationCacheHost;
|
|
class ApplicationCacheResource;
|
|
class SecurityOrigin;
|
|
class SharedBuffer;
|
|
template<typename> class StorageIDJournal;
|
|
|
|
class ApplicationCacheStorage : public RefCounted<ApplicationCacheStorage> {
|
|
public:
|
|
enum FailureReason {
|
|
OriginQuotaReached,
|
|
TotalQuotaReached,
|
|
DiskOrOperationFailure
|
|
};
|
|
|
|
static Ref<ApplicationCacheStorage> create(const String& cacheDirectory, const String& flatFileSubdirectoryName)
|
|
{
|
|
return adoptRef(*new ApplicationCacheStorage(cacheDirectory, flatFileSubdirectoryName));
|
|
}
|
|
|
|
|
|
WEBCORE_EXPORT void setMaximumSize(int64_t size);
|
|
WEBCORE_EXPORT int64_t maximumSize() const;
|
|
bool isMaximumSizeReached() const;
|
|
int64_t spaceNeeded(int64_t cacheToSave);
|
|
|
|
int64_t defaultOriginQuota() const { return m_defaultOriginQuota; }
|
|
WEBCORE_EXPORT void setDefaultOriginQuota(int64_t quota);
|
|
WEBCORE_EXPORT bool calculateUsageForOrigin(const SecurityOriginData&, int64_t& usage);
|
|
WEBCORE_EXPORT bool calculateQuotaForOrigin(const SecurityOrigin&, int64_t& quota);
|
|
bool calculateRemainingSizeForOriginExcludingCache(const SecurityOrigin&, ApplicationCache*, int64_t& remainingSize);
|
|
WEBCORE_EXPORT bool storeUpdatedQuotaForOrigin(const SecurityOrigin*, int64_t quota);
|
|
bool checkOriginQuota(ApplicationCacheGroup*, ApplicationCache* oldCache, ApplicationCache* newCache, int64_t& totalSpaceNeeded);
|
|
|
|
ApplicationCacheGroup* cacheGroupForURL(const URL&); // Cache to load a main resource from.
|
|
ApplicationCacheGroup* fallbackCacheGroupForURL(const URL&); // Cache that has a fallback entry to load a main resource from if normal loading fails.
|
|
|
|
ApplicationCacheGroup* findOrCreateCacheGroup(const URL& manifestURL);
|
|
void cacheGroupDestroyed(ApplicationCacheGroup&);
|
|
void cacheGroupMadeObsolete(ApplicationCacheGroup&);
|
|
|
|
bool storeNewestCache(ApplicationCacheGroup&, ApplicationCache* oldCache, FailureReason&);
|
|
bool storeNewestCache(ApplicationCacheGroup&); // Updates the cache group, but doesn't remove old cache.
|
|
bool store(ApplicationCacheResource*, ApplicationCache*);
|
|
bool storeUpdatedType(ApplicationCacheResource*, ApplicationCache*);
|
|
|
|
// Removes the group if the cache to be removed is the newest one (so, storeNewestCache() needs to be called beforehand when updating).
|
|
void remove(ApplicationCache*);
|
|
|
|
WEBCORE_EXPORT void empty();
|
|
|
|
WEBCORE_EXPORT HashSet<SecurityOriginData> originsWithCache();
|
|
WEBCORE_EXPORT void deleteAllEntries();
|
|
|
|
// FIXME: This should be consolidated with deleteAllEntries().
|
|
WEBCORE_EXPORT void deleteAllCaches();
|
|
|
|
// FIXME: This should be consolidated with deleteCacheGroup().
|
|
WEBCORE_EXPORT void deleteCacheForOrigin(const SecurityOriginData&);
|
|
|
|
// FIXME: This should be consolidated with calculateUsageForOrigin().
|
|
WEBCORE_EXPORT int64_t diskUsageForOrigin(const SecurityOriginData&);
|
|
|
|
static int64_t unknownQuota() { return -1; }
|
|
static int64_t noQuota() { return std::numeric_limits<int64_t>::max(); }
|
|
|
|
private:
|
|
WEBCORE_EXPORT ApplicationCacheStorage(const String& cacheDirectory, const String& flatFileSubdirectoryName);
|
|
|
|
RefPtr<ApplicationCache> loadCache(unsigned storageID);
|
|
ApplicationCacheGroup* loadCacheGroup(const URL& manifestURL);
|
|
std::optional<Vector<URL>> manifestURLs();
|
|
ApplicationCacheGroup* findInMemoryCacheGroup(const URL& manifestURL) const;
|
|
bool deleteCacheGroup(const String& manifestURL);
|
|
void vacuumDatabaseFile();
|
|
|
|
using ResourceStorageIDJournal = StorageIDJournal<ApplicationCacheResource>;
|
|
using GroupStorageIDJournal = StorageIDJournal<ApplicationCacheGroup>;
|
|
|
|
bool store(ApplicationCacheGroup*, GroupStorageIDJournal*);
|
|
bool store(ApplicationCache*, ResourceStorageIDJournal*);
|
|
bool store(ApplicationCacheResource*, unsigned cacheStorageID);
|
|
bool deleteCacheGroupRecord(const String& manifestURL);
|
|
|
|
bool ensureOriginRecord(const SecurityOrigin*);
|
|
static bool shouldStoreResourceAsFlatFile(ApplicationCacheResource*);
|
|
void deleteTables();
|
|
bool writeDataToUniqueFileInDirectory(SharedBuffer&, const String& directory, String& outFilename, const String& fileExtension);
|
|
|
|
void loadManifestHostHashes();
|
|
|
|
void verifySchemaVersion();
|
|
|
|
void openDatabase(bool createIfDoesNotExist);
|
|
|
|
bool executeStatement(SQLiteStatement&);
|
|
bool executeSQLCommand(ASCIILiteral);
|
|
|
|
void checkForMaxSizeReached();
|
|
void checkForDeletedResources();
|
|
long long flatFileAreaSize();
|
|
|
|
const String m_cacheDirectory;
|
|
const String m_flatFileSubdirectoryName;
|
|
String m_cacheFile;
|
|
|
|
int64_t m_maximumSize { noQuota() };
|
|
bool m_isMaximumSizeReached { false };
|
|
|
|
int64_t m_defaultOriginQuota { noQuota() };
|
|
|
|
SQLiteDatabase m_database;
|
|
|
|
// In order to quickly determine if a given resource exists in an application cache,
|
|
// we keep a hash set of the hosts of the manifest URLs of all non-obsolete cache groups.
|
|
HashCountedSet<unsigned, AlreadyHashed> m_cacheHostSet;
|
|
|
|
HashMap<String, ApplicationCacheGroup*> m_cachesInMemory; // Excludes obsolete cache groups.
|
|
|
|
friend class WTF::NeverDestroyed<ApplicationCacheStorage>;
|
|
};
|
|
|
|
} // namespace WebCore
|