Make WebsiteDataStoreConfiguration a proper API object
[WebKit-https.git] / Source / WebKit / UIProcess / API / APIWebsiteDataStore.h
1 /*
2  * Copyright (C) 2014-2017 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include "APIHTTPCookieStore.h"
29 #include "WebsiteDataStore.h"
30 #include <pal/SessionID.h>
31 #include <wtf/text/WTFString.h>
32
33 namespace API {
34
35 class WebsiteDataStore final : public ObjectImpl<Object::Type::WebsiteDataStore> {
36 public:
37     static Ref<WebsiteDataStore> defaultDataStore();
38     static bool defaultDataStoreExists();
39     static void deleteDefaultDataStoreForTesting();
40
41     static Ref<WebsiteDataStore> createNonPersistentDataStore();
42     static Ref<WebsiteDataStore> createLegacy(Ref<WebKit::WebsiteDataStoreConfiguration>&&);
43
44     explicit WebsiteDataStore(Ref<WebKit::WebsiteDataStoreConfiguration>&&, PAL::SessionID);
45     virtual ~WebsiteDataStore();
46
47     bool isPersistent();
48
49     bool resourceLoadStatisticsEnabled() const;
50     void setResourceLoadStatisticsEnabled(bool);
51     bool resourceLoadStatisticsDebugMode() const;
52     void setResourceLoadStatisticsDebugMode(bool);
53
54     WebKit::WebsiteDataStore& websiteDataStore() { return m_websiteDataStore.get(); }
55     HTTPCookieStore& httpCookieStore();
56
57     static WTF::String defaultApplicationCacheDirectory();
58     static WTF::String defaultCacheStorageDirectory();
59     static WTF::String defaultNetworkCacheDirectory();
60     static WTF::String defaultMediaCacheDirectory();
61     static WTF::String defaultIndexedDBDatabaseDirectory();
62     static WTF::String defaultServiceWorkerRegistrationDirectory();
63     static WTF::String defaultLocalStorageDirectory();
64     static WTF::String defaultMediaKeysStorageDirectory();
65     static WTF::String defaultWebSQLDatabaseDirectory();
66     static WTF::String defaultResourceLoadStatisticsDirectory();
67     static WTF::String defaultJavaScriptConfigurationDirectory();
68
69     static Ref<WebKit::WebsiteDataStoreConfiguration> defaultDataStoreConfiguration();
70
71     static WTF::String legacyDefaultApplicationCacheDirectory();
72     static WTF::String legacyDefaultNetworkCacheDirectory();
73     static WTF::String legacyDefaultLocalStorageDirectory();
74     static WTF::String legacyDefaultIndexedDBDatabaseDirectory();
75     static WTF::String legacyDefaultWebSQLDatabaseDirectory();
76     static WTF::String legacyDefaultMediaKeysStorageDirectory();
77     static WTF::String legacyDefaultMediaCacheDirectory();
78     static WTF::String legacyDefaultJavaScriptConfigurationDirectory();
79
80     static Ref<WebKit::WebsiteDataStoreConfiguration> legacyDefaultDataStoreConfiguration();
81
82 private:
83     enum ShouldCreateDirectory { CreateDirectory, DontCreateDirectory };
84
85     WebsiteDataStore();
86
87     static WTF::String tempDirectoryFileSystemRepresentation(const WTF::String& directoryName, ShouldCreateDirectory = CreateDirectory);
88     static WTF::String cacheDirectoryFileSystemRepresentation(const WTF::String& directoryName);
89     static WTF::String websiteDataDirectoryFileSystemRepresentation(const WTF::String& directoryName);
90
91     Ref<WebKit::WebsiteDataStore> m_websiteDataStore;
92     RefPtr<HTTPCookieStore> m_apiHTTPCookieStore;
93 };
94
95 }