Rename experimental feature for process swap on navigation
[WebKit-https.git] / Source / WebKit / UIProcess / WebPreferences.cpp
1 /*
2  * Copyright (C) 2010, 2011 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 #include "config.h"
27 #include "WebPreferences.h"
28
29 #include "WebPageGroup.h"
30 #include "WebPreferencesKeys.h"
31 #include "WebProcessPool.h"
32 #include <WebCore/LibWebRTCProvider.h>
33 #include <wtf/NeverDestroyed.h>
34 #include <wtf/ThreadingPrimitives.h>
35
36 namespace WebKit {
37
38 // FIXME: Manipulating this variable is not thread safe.
39 // Instead of tracking private browsing state as a boolean preference, we should let the client provide storage sessions explicitly.
40 static unsigned privateBrowsingPageCount;
41
42 Ref<WebPreferences> WebPreferences::create(const String& identifier, const String& keyPrefix, const String& globalDebugKeyPrefix)
43 {
44     return adoptRef(*new WebPreferences(identifier, keyPrefix, globalDebugKeyPrefix));
45 }
46
47 Ref<WebPreferences> WebPreferences::createWithLegacyDefaults(const String& identifier, const String& keyPrefix, const String& globalDebugKeyPrefix)
48 {
49     auto preferences = WebPreferences::create(identifier, keyPrefix, globalDebugKeyPrefix);
50     // FIXME: The registerDefault...ValueForKey machinery is unnecessarily heavyweight and complicated.
51     // We can just compute different defaults for modern and legacy APIs in WebPreferencesDefinitions.h macros.
52     preferences->registerDefaultBoolValueForKey(WebPreferencesKey::javaEnabledKey(), true);
53     preferences->registerDefaultBoolValueForKey(WebPreferencesKey::javaEnabledForLocalFilesKey(), true);
54     preferences->registerDefaultBoolValueForKey(WebPreferencesKey::pluginsEnabledKey(), true);
55     preferences->registerDefaultUInt32ValueForKey(WebPreferencesKey::storageBlockingPolicyKey(), WebCore::SecurityOrigin::AllowAllStorage);
56     return preferences;
57 }
58
59 WebPreferences::WebPreferences(const String& identifier, const String& keyPrefix, const String& globalDebugKeyPrefix)
60     : m_identifier(identifier)
61     , m_keyPrefix(keyPrefix)
62     , m_globalDebugKeyPrefix(globalDebugKeyPrefix)
63 {
64     platformInitializeStore();
65 }
66
67 WebPreferences::WebPreferences(const WebPreferences& other)
68     : m_identifier()
69     , m_keyPrefix(other.m_keyPrefix)
70     , m_globalDebugKeyPrefix(other.m_globalDebugKeyPrefix)
71     , m_store(other.m_store)
72 {
73     platformInitializeStore();
74 }
75
76 WebPreferences::~WebPreferences()
77 {
78     ASSERT(m_pages.isEmpty());
79 }
80
81 Ref<WebPreferences> WebPreferences::copy() const
82 {
83     return adoptRef(*new WebPreferences(*this));
84 }
85
86 void WebPreferences::addPage(WebPageProxy& webPageProxy)
87 {
88     ASSERT(!m_pages.contains(&webPageProxy));
89     m_pages.add(&webPageProxy);
90
91     if (privateBrowsingEnabled()) {
92         if (!privateBrowsingPageCount)
93             WebProcessPool::willStartUsingPrivateBrowsing();
94
95         ++privateBrowsingPageCount;
96     }
97 }
98
99 void WebPreferences::removePage(WebPageProxy& webPageProxy)
100 {
101     ASSERT(m_pages.contains(&webPageProxy));
102     m_pages.remove(&webPageProxy);
103
104     if (privateBrowsingEnabled()) {
105         --privateBrowsingPageCount;
106         if (!privateBrowsingPageCount)
107             WebProcessPool::willStopUsingPrivateBrowsing();
108     }
109 }
110
111 void WebPreferences::update()
112 {
113     for (auto& webPageProxy : m_pages)
114         webPageProxy->preferencesDidChange();
115 }
116
117 void WebPreferences::updateStringValueForKey(const String& key, const String& value)
118 {
119     platformUpdateStringValueForKey(key, value);
120     update(); // FIXME: Only send over the changed key and value.
121 }
122
123 void WebPreferences::updateBoolValueForKey(const String& key, bool value)
124 {
125     if (key == WebPreferencesKey::privateBrowsingEnabledKey()) {
126         updatePrivateBrowsingValue(value);
127         return;
128     }
129
130     platformUpdateBoolValueForKey(key, value);
131     update(); // FIXME: Only send over the changed key and value.
132 }
133
134 void WebPreferences::updateBoolValueForExperimentalFeatureKey(const String& key, bool value)
135 {
136     if (key == WebPreferencesKey::processSwapOnCrossSiteNavigationEnabledKey()) {
137         for (auto* page : m_pages)
138             page->process().processPool().configuration().setProcessSwapsOnNavigation(value);
139
140         return;
141     }
142
143     update(); // FIXME: Only send over the changed key and value.
144 }
145
146 void WebPreferences::updateUInt32ValueForKey(const String& key, uint32_t value)
147 {
148     platformUpdateUInt32ValueForKey(key, value);
149     update(); // FIXME: Only send over the changed key and value.
150 }
151
152 void WebPreferences::updateDoubleValueForKey(const String& key, double value)
153 {
154     platformUpdateDoubleValueForKey(key, value);
155     update(); // FIXME: Only send over the changed key and value.
156 }
157
158 void WebPreferences::updateFloatValueForKey(const String& key, float value)
159 {
160     platformUpdateFloatValueForKey(key, value);
161     update(); // FIXME: Only send over the changed key and value.
162 }
163
164 void WebPreferences::updatePrivateBrowsingValue(bool value)
165 {
166     platformUpdateBoolValueForKey(WebPreferencesKey::privateBrowsingEnabledKey(), value);
167
168     unsigned pagesChanged = m_pages.size();
169     if (!pagesChanged)
170         return;
171
172     if (value) {
173         if (!privateBrowsingPageCount)
174             WebProcessPool::willStartUsingPrivateBrowsing();
175         privateBrowsingPageCount += pagesChanged;
176     }
177
178     update(); // FIXME: Only send over the changed key and value.
179
180     if (!value) {
181         ASSERT(privateBrowsingPageCount >= pagesChanged);
182         privateBrowsingPageCount -= pagesChanged;
183         if (!privateBrowsingPageCount)
184             WebProcessPool::willStopUsingPrivateBrowsing();
185     }
186 }
187
188 #define DEFINE_PREFERENCE_GETTER_AND_SETTERS(KeyUpper, KeyLower, TypeName, Type, DefaultValue, HumanReadableName, HumanReadableDescription) \
189     void WebPreferences::set##KeyUpper(const Type& value) \
190     { \
191         if (!m_store.set##TypeName##ValueForKey(WebPreferencesKey::KeyLower##Key(), value)) \
192             return; \
193         update##TypeName##ValueForKey(WebPreferencesKey::KeyLower##Key(), value); \
194         \
195     } \
196     \
197     Type WebPreferences::KeyLower() const \
198     { \
199         return m_store.get##TypeName##ValueForKey(WebPreferencesKey::KeyLower##Key()); \
200     } \
201
202 FOR_EACH_WEBKIT_PREFERENCE(DEFINE_PREFERENCE_GETTER_AND_SETTERS)
203 FOR_EACH_WEBKIT_DEBUG_PREFERENCE(DEFINE_PREFERENCE_GETTER_AND_SETTERS)
204
205 #undef DEFINE_PREFERENCE_GETTER_AND_SETTERS
206
207
208 bool WebPreferences::anyPagesAreUsingPrivateBrowsing()
209 {
210     return privateBrowsingPageCount;
211 }
212
213 void WebPreferences::registerDefaultBoolValueForKey(const String& key, bool value)
214 {
215     m_store.setOverrideDefaultsBoolValueForKey(key, value);
216     bool userValue;
217     if (platformGetBoolUserValueForKey(key, userValue))
218         m_store.setBoolValueForKey(key, userValue);
219 }
220
221 void WebPreferences::registerDefaultUInt32ValueForKey(const String& key, uint32_t value)
222 {
223     m_store.setOverrideDefaultsUInt32ValueForKey(key, value);
224     uint32_t userValue;
225     if (platformGetUInt32UserValueForKey(key, userValue))
226         m_store.setUInt32ValueForKey(key, userValue);
227 }
228
229 } // namespace WebKit