WKWebsiteDataStore.mm [plain text]
/*
* Copyright (C) 2014-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.
*/
#import "config.h"
#import "WKWebsiteDataStoreInternal.h"
#if WK_API_ENABLED
#import "APIString.h"
#import "WKHTTPCookieStoreInternal.h"
#import "WKNSArray.h"
#import "WKWebViewInternal.h"
#import "WKWebsiteDataRecordInternal.h"
#import "WebPageProxy.h"
#import "WebResourceLoadStatisticsStore.h"
#import "WebResourceLoadStatisticsTelemetry.h"
#import "WebsiteDataFetchOption.h"
#import "_WKWebsiteDataStoreConfiguration.h"
#import <WebCore/URL.h>
#import <WebKit/ServiceWorkerProcessProxy.h>
#import <wtf/BlockPtr.h>
using namespace WebCore;
@implementation WKWebsiteDataStore
+ (WKWebsiteDataStore *)defaultDataStore
{
return WebKit::wrapper(API::WebsiteDataStore::defaultDataStore().get());
}
+ (WKWebsiteDataStore *)nonPersistentDataStore
{
return [WebKit::wrapper(API::WebsiteDataStore::createNonPersistentDataStore().leakRef()) autorelease];
}
- (void)dealloc
{
_websiteDataStore->API::WebsiteDataStore::~WebsiteDataStore();
[super dealloc];
}
+ (BOOL)supportsSecureCoding
{
return YES;
}
- (instancetype)initWithCoder:(NSCoder *)coder
{
if (!(self = [super init]))
return nil;
RetainPtr<WKWebsiteDataStore> dataStore;
if ([coder decodeBoolForKey:@"isDefaultDataStore"])
dataStore = [WKWebsiteDataStore defaultDataStore];
else
dataStore = [WKWebsiteDataStore nonPersistentDataStore];
[self release];
return dataStore.leakRef();
}
- (void)encodeWithCoder:(NSCoder *)coder
{
if (self == [WKWebsiteDataStore defaultDataStore]) {
[coder encodeBool:YES forKey:@"isDefaultDataStore"];
return;
}
ASSERT(!self.persistent);
}
- (BOOL)isPersistent
{
return _websiteDataStore->isPersistent();
}
+ (NSSet *)allWebsiteDataTypes
{
static dispatch_once_t onceToken;
static NSSet *allWebsiteDataTypes;
dispatch_once(&onceToken, ^{
allWebsiteDataTypes = [[NSSet alloc] initWithArray:@[ WKWebsiteDataTypeDiskCache, WKWebsiteDataTypeFetchCache, WKWebsiteDataTypeMemoryCache, WKWebsiteDataTypeOfflineWebApplicationCache, WKWebsiteDataTypeCookies, WKWebsiteDataTypeSessionStorage, WKWebsiteDataTypeLocalStorage, WKWebsiteDataTypeIndexedDBDatabases, WKWebsiteDataTypeServiceWorkerRegistrations, WKWebsiteDataTypeWebSQLDatabases ]];
});
return allWebsiteDataTypes;
}
- (WKHTTPCookieStore *)httpCookieStore
{
return WebKit::wrapper(_websiteDataStore->httpCookieStore());
}
static WallTime toSystemClockTime(NSDate *date)
{
ASSERT(date);
return WallTime::fromRawSeconds(date.timeIntervalSince1970);
}
- (void)fetchDataRecordsOfTypes:(NSSet *)dataTypes completionHandler:(void (^)(NSArray<WKWebsiteDataRecord *> *))completionHandler
{
[self _fetchDataRecordsOfTypes:dataTypes withOptions:0 completionHandler:completionHandler];
}
- (void)removeDataOfTypes:(NSSet *)dataTypes modifiedSince:(NSDate *)date completionHandler:(void (^)(void))completionHandler
{
auto completionHandlerCopy = makeBlockPtr(completionHandler);
_websiteDataStore->websiteDataStore().removeData(WebKit::toWebsiteDataTypes(dataTypes), toSystemClockTime(date ? date : [NSDate distantPast]), [completionHandlerCopy] {
completionHandlerCopy();
});
}
static Vector<WebKit::WebsiteDataRecord> toWebsiteDataRecords(NSArray *dataRecords)
{
Vector<WebKit::WebsiteDataRecord> result;
for (WKWebsiteDataRecord *dataRecord in dataRecords)
result.append(dataRecord->_websiteDataRecord->websiteDataRecord());
return result;
}
- (void)removeDataOfTypes:(NSSet *)dataTypes forDataRecords:(NSArray *)dataRecords completionHandler:(void (^)(void))completionHandler
{
auto completionHandlerCopy = makeBlockPtr(completionHandler);
_websiteDataStore->websiteDataStore().removeData(WebKit::toWebsiteDataTypes(dataTypes), toWebsiteDataRecords(dataRecords), [completionHandlerCopy] {
completionHandlerCopy();
});
}
#pragma mark WKObject protocol implementation
- (API::Object&)_apiObject
{
return *_websiteDataStore;
}
@end
@implementation WKWebsiteDataStore (WKPrivate)
+ (NSSet<NSString *> *)_allWebsiteDataTypesIncludingPrivate
{
static dispatch_once_t onceToken;
static NSSet *allWebsiteDataTypes;
dispatch_once(&onceToken, ^ {
auto *privateTypes = @[_WKWebsiteDataTypeHSTSCache, _WKWebsiteDataTypeMediaKeys, _WKWebsiteDataTypeSearchFieldRecentSearches, _WKWebsiteDataTypeResourceLoadStatistics, _WKWebsiteDataTypeCredentials
#if !TARGET_OS_IPHONE
, _WKWebsiteDataTypePlugInData
#endif
];
allWebsiteDataTypes = [[[self allWebsiteDataTypes] setByAddingObjectsFromArray:privateTypes] retain];
});
return allWebsiteDataTypes;
}
+ (BOOL)_defaultDataStoreExists
{
return API::WebsiteDataStore::defaultDataStoreExists();
}
- (instancetype)_initWithConfiguration:(_WKWebsiteDataStoreConfiguration *)configuration
{
if (!(self = [super init]))
return nil;
auto config = API::WebsiteDataStore::defaultDataStoreConfiguration();
if (configuration._webStorageDirectory)
config.localStorageDirectory = configuration._webStorageDirectory.path;
if (configuration._webSQLDatabaseDirectory)
config.webSQLDatabaseDirectory = configuration._webSQLDatabaseDirectory.path;
if (configuration._indexedDBDatabaseDirectory)
config.indexedDBDatabaseDirectory = configuration._indexedDBDatabaseDirectory.path;
if (configuration._cookieStorageFile)
config.cookieStorageFile = configuration._cookieStorageFile.path;
if (configuration._resourceLoadStatisticsDirectory)
config.resourceLoadStatisticsDirectory = configuration._resourceLoadStatisticsDirectory.path;
if (configuration._cacheStorageDirectory)
config.cacheStorageDirectory = configuration._cacheStorageDirectory.path;
if (configuration._serviceWorkerRegistrationDirectory)
config.serviceWorkerRegistrationDirectory = configuration._serviceWorkerRegistrationDirectory.path;
API::Object::constructInWrapper<API::WebsiteDataStore>(self, config, PAL::SessionID::generatePersistentSessionID());
return self;
}
- (void)_fetchDataRecordsOfTypes:(NSSet<NSString *> *)dataTypes withOptions:(_WKWebsiteDataStoreFetchOptions)options completionHandler:(void (^)(NSArray<WKWebsiteDataRecord *> *))completionHandler
{
auto completionHandlerCopy = makeBlockPtr(completionHandler);
OptionSet<WebKit::WebsiteDataFetchOption> fetchOptions;
if (options & _WKWebsiteDataStoreFetchOptionComputeSizes)
fetchOptions |= WebKit::WebsiteDataFetchOption::ComputeSizes;
_websiteDataStore->websiteDataStore().fetchData(WebKit::toWebsiteDataTypes(dataTypes), fetchOptions, [completionHandlerCopy = WTFMove(completionHandlerCopy)](auto websiteDataRecords) {
Vector<RefPtr<API::Object>> elements;
elements.reserveInitialCapacity(websiteDataRecords.size());
for (auto& websiteDataRecord : websiteDataRecords)
elements.uncheckedAppend(API::WebsiteDataRecord::create(WTFMove(websiteDataRecord)));
completionHandlerCopy(wrapper(API::Array::create(WTFMove(elements))));
});
}
- (BOOL)_resourceLoadStatisticsEnabled
{
return _websiteDataStore->websiteDataStore().resourceLoadStatisticsEnabled();
}
- (void)_setResourceLoadStatisticsEnabled:(BOOL)enabled
{
_websiteDataStore->websiteDataStore().setResourceLoadStatisticsEnabled(enabled);
}
- (BOOL)_resourceLoadStatisticsDebugMode
{
return _websiteDataStore->websiteDataStore().resourceLoadStatisticsDebugMode();
}
- (void)_setResourceLoadStatisticsDebugMode:(BOOL)enabled
{
_websiteDataStore->websiteDataStore().setResourceLoadStatisticsDebugMode(enabled);
}
- (NSUInteger)_cacheStoragePerOriginQuota
{
return _websiteDataStore->websiteDataStore().cacheStoragePerOriginQuota();
}
- (void)_setCacheStoragePerOriginQuota:(NSUInteger)size
{
_websiteDataStore->websiteDataStore().setCacheStoragePerOriginQuota(size);
}
- (NSString *)_cacheStorageDirectory
{
return _websiteDataStore->websiteDataStore().cacheStorageDirectory();
}
- (void)_setCacheStorageDirectory:(NSString *)directory
{
_websiteDataStore->websiteDataStore().setCacheStorageDirectory(directory);
}
- (NSString *)_serviceWorkerRegistrationDirectory
{
return _websiteDataStore->websiteDataStore().serviceWorkerRegistrationDirectory();
}
- (void)_setServiceWorkerRegistrationDirectory:(NSString *)directory
{
_websiteDataStore->websiteDataStore().setServiceWorkerRegistrationDirectory(directory);
}
- (void)_setBoundInterfaceIdentifier:(NSString *)identifier
{
_websiteDataStore->websiteDataStore().setBoundInterfaceIdentifier(identifier);
}
- (NSString *)_boundInterfaceIdentifier
{
return _websiteDataStore->websiteDataStore().boundInterfaceIdentifier();
}
- (void)_setAllowsCellularAccess:(BOOL)allows
{
_websiteDataStore->websiteDataStore().setAllowsCellularAccess(allows ? WebKit::AllowsCellularAccess::Yes : WebKit::AllowsCellularAccess::No);
}
- (BOOL)_allowsCellularAccess
{
return _websiteDataStore->websiteDataStore().allowsCellularAccess() == WebKit::AllowsCellularAccess::Yes;
}
- (void)_setProxyConfiguration:(NSDictionary *)configuration
{
_websiteDataStore->websiteDataStore().setProxyConfiguration((__bridge CFDictionaryRef)configuration);
}
- (NSDictionary *)_proxyConfiguration
{
return (__bridge NSDictionary *)_websiteDataStore->websiteDataStore().proxyConfiguration();
}
- (void)_resourceLoadStatisticsSetShouldSubmitTelemetry:(BOOL)value
{
auto* store = _websiteDataStore->websiteDataStore().resourceLoadStatistics();
if (!store)
return;
store->setShouldSubmitTelemetry(value);
}
- (void)_setResourceLoadStatisticsTestingCallback:(void (^)(WKWebsiteDataStore *, NSString *))callback
{
if (!_websiteDataStore->isPersistent())
return;
if (callback) {
_websiteDataStore->websiteDataStore().enableResourceLoadStatisticsAndSetTestingCallback([callback = makeBlockPtr(callback), self](const String& event) {
callback(self, (NSString *)event);
});
return;
}
auto* store = _websiteDataStore->websiteDataStore().resourceLoadStatistics();
if (!store)
return;
store->setStatisticsTestingCallback(nullptr);
}
+ (void)_allowWebsiteDataRecordsForAllOrigins
{
WebKit::WebsiteDataStore::allowWebsiteDataRecordsForAllOrigins();
}
- (void)_getAllStorageAccessEntriesFor:(WKWebView *)webView completionHandler:(void (^)(NSArray<NSString *> *domains))completionHandler
{
if (!webView) {
completionHandler({ });
return;
}
auto* webPageProxy = [webView _page];
if (!webPageProxy) {
completionHandler({ });
return;
}
_websiteDataStore->websiteDataStore().getAllStorageAccessEntries(webPageProxy->pageID(), [completionHandler = makeBlockPtr(completionHandler)](auto domains) {
Vector<RefPtr<API::Object>> apiDomains;
apiDomains.reserveInitialCapacity(domains.size());
for (auto& domain : domains)
apiDomains.uncheckedAppend(API::String::create(domain));
completionHandler(wrapper(API::Array::create(WTFMove(apiDomains))));
});
}
- (bool)_hasRegisteredServiceWorker
{
return WebKit::ServiceWorkerProcessProxy::hasRegisteredServiceWorkers(_websiteDataStore->websiteDataStore().serviceWorkerRegistrationDirectory());
}
@end
#endif // WK_API_ENABLED