| /* |
| * Copyright (C) 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. AND ITS CONTRIBUTORS ``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 ITS 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 "CacheStorageEngineCaches.h" |
| #include "NetworkCacheData.h" |
| #include "WebsiteData.h" |
| #include <WebCore/ClientOrigin.h> |
| #include <WebCore/StorageQuotaManager.h> |
| #include <pal/SessionID.h> |
| #include <wtf/HashMap.h> |
| #include <wtf/RefCounted.h> |
| #include <wtf/WeakPtr.h> |
| #include <wtf/WorkQueue.h> |
| |
| namespace IPC { |
| class Connection; |
| } |
| |
| namespace WTF { |
| class CallbackAggregator; |
| }; |
| |
| namespace WebKit { |
| |
| class NetworkProcess; |
| |
| namespace CacheStorage { |
| |
| using CacheIdentifier = uint64_t; |
| using LockCount = uint64_t; |
| |
| class Engine : public RefCounted<Engine>, public CanMakeWeakPtr<Engine> { |
| public: |
| ~Engine(); |
| |
| static void from(NetworkProcess&, PAL::SessionID, Function<void(Engine&)>&&); |
| static void destroyEngine(NetworkProcess&, PAL::SessionID); |
| static void fetchEntries(NetworkProcess&, PAL::SessionID, bool shouldComputeSize, CompletionHandler<void(Vector<WebsiteData::Entry>)>&&); |
| |
| static void open(NetworkProcess&, PAL::SessionID, WebCore::ClientOrigin&&, String&& cacheName, WebCore::DOMCacheEngine::CacheIdentifierCallback&&); |
| static void remove(NetworkProcess&, PAL::SessionID, uint64_t cacheIdentifier, WebCore::DOMCacheEngine::CacheIdentifierCallback&&); |
| static void retrieveCaches(NetworkProcess&, PAL::SessionID, WebCore::ClientOrigin&&, uint64_t updateCounter, WebCore::DOMCacheEngine::CacheInfosCallback&&); |
| |
| static void retrieveRecords(NetworkProcess&, PAL::SessionID, uint64_t cacheIdentifier, URL&&, WebCore::DOMCacheEngine::RecordsCallback&&); |
| static void putRecords(NetworkProcess&, PAL::SessionID, uint64_t cacheIdentifier, Vector<WebCore::DOMCacheEngine::Record>&&, WebCore::DOMCacheEngine::RecordIdentifiersCallback&&); |
| static void deleteMatchingRecords(NetworkProcess&, PAL::SessionID, uint64_t cacheIdentifier, WebCore::ResourceRequest&&, WebCore::CacheQueryOptions&&, WebCore::DOMCacheEngine::RecordIdentifiersCallback&&); |
| |
| static void lock(NetworkProcess&, PAL::SessionID, uint64_t cacheIdentifier); |
| static void unlock(NetworkProcess&, PAL::SessionID, uint64_t cacheIdentifier); |
| |
| static void clearMemoryRepresentation(NetworkProcess&, PAL::SessionID, WebCore::ClientOrigin&&, WebCore::DOMCacheEngine::CompletionCallback&&); |
| static void representation(NetworkProcess&, PAL::SessionID, CompletionHandler<void(String&&)>&&); |
| |
| static void clearAllCaches(NetworkProcess&, PAL::SessionID, CompletionHandler<void()>&&); |
| static void clearCachesForOrigin(NetworkProcess&, PAL::SessionID, WebCore::SecurityOriginData&&, CompletionHandler<void()>&&); |
| |
| static void initializeQuotaUser(NetworkProcess&, PAL::SessionID, const WebCore::ClientOrigin&, CompletionHandler<void()>&&); |
| |
| static uint64_t diskUsage(const String& rootPath, const WebCore::ClientOrigin&); |
| void requestSpace(const WebCore::ClientOrigin&, uint64_t spaceRequested, CompletionHandler<void(WebCore::StorageQuotaManager::Decision)>&&); |
| |
| bool shouldPersist() const { return !!m_ioQueue;} |
| |
| void writeFile(const String& filename, NetworkCache::Data&&, WebCore::DOMCacheEngine::CompletionCallback&&); |
| void readFile(const String& filename, CompletionHandler<void(const NetworkCache::Data&, int error)>&&); |
| void removeFile(const String& filename); |
| void writeSizeFile(const String&, uint64_t size, CompletionHandler<void()>&&); |
| static Optional<uint64_t> readSizeFile(const String&); |
| |
| const String& rootPath() const { return m_rootPath; } |
| const NetworkCache::Salt& salt() const { return m_salt.value(); } |
| uint64_t nextCacheIdentifier() { return ++m_nextCacheIdentifier; } |
| |
| private: |
| Engine(PAL::SessionID, NetworkProcess&, String&& rootPath); |
| |
| void open(const WebCore::ClientOrigin&, const String& cacheName, WebCore::DOMCacheEngine::CacheIdentifierCallback&&); |
| void remove(uint64_t cacheIdentifier, WebCore::DOMCacheEngine::CacheIdentifierCallback&&); |
| void retrieveCaches(const WebCore::ClientOrigin&, uint64_t updateCounter, WebCore::DOMCacheEngine::CacheInfosCallback&&); |
| |
| void clearAllCaches(CompletionHandler<void()>&&); |
| void clearAllCachesFromDisk(CompletionHandler<void()>&&); |
| void clearCachesForOrigin(const WebCore::SecurityOriginData&, CompletionHandler<void()>&&); |
| void clearCachesForOriginFromDisk(const WebCore::SecurityOriginData&, CompletionHandler<void()>&&); |
| void deleteDirectoryRecursivelyOnBackgroundThread(const String& path, CompletionHandler<void()>&&); |
| |
| void clearMemoryRepresentation(const WebCore::ClientOrigin&, WebCore::DOMCacheEngine::CompletionCallback&&); |
| String representation(); |
| |
| void retrieveRecords(uint64_t cacheIdentifier, URL&&, WebCore::DOMCacheEngine::RecordsCallback&&); |
| void putRecords(uint64_t cacheIdentifier, Vector<WebCore::DOMCacheEngine::Record>&&, WebCore::DOMCacheEngine::RecordIdentifiersCallback&&); |
| void deleteMatchingRecords(uint64_t cacheIdentifier, WebCore::ResourceRequest&&, WebCore::CacheQueryOptions&&, WebCore::DOMCacheEngine::RecordIdentifiersCallback&&); |
| |
| void lock(uint64_t cacheIdentifier); |
| void unlock(uint64_t cacheIdentifier); |
| |
| String cachesRootPath(const WebCore::ClientOrigin&); |
| |
| void fetchEntries(bool /* shouldComputeSize */, CompletionHandler<void(Vector<WebsiteData::Entry>)>&&); |
| |
| void getDirectories(CompletionHandler<void(const Vector<String>&)>&&); |
| void fetchDirectoryEntries(bool shouldComputeSize, const Vector<String>& folderPaths, CompletionHandler<void(Vector<WebsiteData::Entry>)>&&); |
| void clearCachesForOriginFromDirectories(const Vector<String>&, const WebCore::SecurityOriginData&, CompletionHandler<void()>&&); |
| |
| void initialize(WebCore::DOMCacheEngine::CompletionCallback&&); |
| |
| using CachesOrError = Expected<std::reference_wrapper<Caches>, WebCore::DOMCacheEngine::Error>; |
| using CachesCallback = Function<void(CachesOrError&&)>; |
| void readCachesFromDisk(const WebCore::ClientOrigin&, CachesCallback&&); |
| |
| using CacheOrError = Expected<std::reference_wrapper<Cache>, WebCore::DOMCacheEngine::Error>; |
| using CacheCallback = Function<void(CacheOrError&&)>; |
| void readCache(uint64_t cacheIdentifier, CacheCallback&&); |
| |
| CompletionHandler<void()> createClearTask(CompletionHandler<void()>&&); |
| |
| Cache* cache(uint64_t cacheIdentifier); |
| |
| PAL::SessionID m_sessionID; |
| WeakPtr<NetworkProcess> m_networkProcess; |
| HashMap<WebCore::ClientOrigin, RefPtr<Caches>> m_caches; |
| uint64_t m_nextCacheIdentifier { 0 }; |
| String m_rootPath; |
| RefPtr<WorkQueue> m_ioQueue; |
| Optional<NetworkCache::Salt> m_salt; |
| HashMap<CacheIdentifier, LockCount> m_cacheLocks; |
| Vector<WebCore::DOMCacheEngine::CompletionCallback> m_initializationCallbacks; |
| HashMap<uint64_t, WebCore::DOMCacheEngine::CompletionCallback> m_pendingWriteCallbacks; |
| HashMap<uint64_t, CompletionHandler<void(const NetworkCache::Data&, int error)>> m_pendingReadCallbacks; |
| uint64_t m_pendingCallbacksCounter { 0 }; |
| Vector<WebCore::DOMCacheEngine::CompletionCallback> m_pendingClearCallbacks; |
| uint64_t m_clearTaskCounter { 0 }; |
| }; |
| |
| } // namespace CacheStorage |
| |
| } // namespace WebKit |