d06957daef6677f71935f7f5b13e52913dbddec5
[WebKit-https.git] / Source / WebCore / page / Settings.h
1 /*
2  * Copyright (C) 2003-2016 Apple Inc. All rights reserved.
3  *           (C) 2006 Graham Dennis (graham.dennis@gmail.com)
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
25  */
26
27 #pragma once
28
29 #include "ClipboardAccessPolicy.h"
30 #include "EditingBehaviorTypes.h"
31 #include "IntSize.h"
32 #include "SecurityOrigin.h"
33 #include "SettingsMacros.h"
34 #include "TextFlags.h"
35 #include "Timer.h"
36 #include "URL.h"
37 #include "WritingMode.h"
38 #include <chrono>
39 #include <runtime/RuntimeFlags.h>
40 #include <unicode/uscript.h>
41 #include <wtf/HashMap.h>
42 #include <wtf/RefCounted.h>
43 #include <wtf/text/AtomicString.h>
44 #include <wtf/text/AtomicStringHash.h>
45
46 #if ENABLE(DATA_DETECTION)
47 #include "DataDetection.h"
48 #endif
49
50 namespace WebCore {
51
52 class FontGenericFamilies;
53 class Page;
54
55 enum EditableLinkBehavior {
56     EditableLinkDefaultBehavior,
57     EditableLinkAlwaysLive,
58     EditableLinkOnlyLiveWithShiftKey,
59     EditableLinkLiveWhenNotFocused,
60     EditableLinkNeverLive
61 };
62
63 enum TextDirectionSubmenuInclusionBehavior {
64     TextDirectionSubmenuNeverIncluded,
65     TextDirectionSubmenuAutomaticallyIncluded,
66     TextDirectionSubmenuAlwaysIncluded
67 };
68
69 enum DebugOverlayRegionFlags {
70     NonFastScrollableRegion = 1 << 0,
71     WheelEventHandlerRegion = 1 << 1,
72 };
73
74 enum class UserInterfaceDirectionPolicy {
75     Content,
76     System
77 };
78
79 enum PDFImageCachingPolicy {
80     PDFImageCachingEnabled,
81     PDFImageCachingBelowMemoryLimit,
82     PDFImageCachingDisabled,
83     PDFImageCachingClipBoundsOnly,
84 #if PLATFORM(IOS)
85     PDFImageCachingDefault = PDFImageCachingBelowMemoryLimit
86 #else
87     PDFImageCachingDefault = PDFImageCachingEnabled
88 #endif
89 };
90
91 typedef unsigned DebugOverlayRegions;
92
93 class Settings : public RefCounted<Settings> {
94     WTF_MAKE_NONCOPYABLE(Settings); WTF_MAKE_FAST_ALLOCATED;
95 public:
96     static Ref<Settings> create(Page*);
97     ~Settings();
98
99     void pageDestroyed() { m_page = nullptr; }
100
101     enum class ForcedAccessibilityValue { System, On, Off };
102     static const Settings::ForcedAccessibilityValue defaultForcedColorsAreInvertedAccessibilityValue = ForcedAccessibilityValue::System;
103     static const Settings::ForcedAccessibilityValue defaultForcedDisplayIsMonochromeAccessibilityValue = ForcedAccessibilityValue::System;
104     static const Settings::ForcedAccessibilityValue defaultForcedPrefersReducedMotionAccessibilityValue = ForcedAccessibilityValue::System;
105
106     WEBCORE_EXPORT void setStandardFontFamily(const AtomicString&, UScriptCode = USCRIPT_COMMON);
107     WEBCORE_EXPORT const AtomicString& standardFontFamily(UScriptCode = USCRIPT_COMMON) const;
108
109     WEBCORE_EXPORT void setFixedFontFamily(const AtomicString&, UScriptCode = USCRIPT_COMMON);
110     WEBCORE_EXPORT const AtomicString& fixedFontFamily(UScriptCode = USCRIPT_COMMON) const;
111
112     WEBCORE_EXPORT void setSerifFontFamily(const AtomicString&, UScriptCode = USCRIPT_COMMON);
113     WEBCORE_EXPORT const AtomicString& serifFontFamily(UScriptCode = USCRIPT_COMMON) const;
114
115     WEBCORE_EXPORT void setSansSerifFontFamily(const AtomicString&, UScriptCode = USCRIPT_COMMON);
116     WEBCORE_EXPORT const AtomicString& sansSerifFontFamily(UScriptCode = USCRIPT_COMMON) const;
117
118     WEBCORE_EXPORT void setCursiveFontFamily(const AtomicString&, UScriptCode = USCRIPT_COMMON);
119     WEBCORE_EXPORT const AtomicString& cursiveFontFamily(UScriptCode = USCRIPT_COMMON) const;
120
121     WEBCORE_EXPORT void setFantasyFontFamily(const AtomicString&, UScriptCode = USCRIPT_COMMON);
122     WEBCORE_EXPORT const AtomicString& fantasyFontFamily(UScriptCode = USCRIPT_COMMON) const;
123
124     WEBCORE_EXPORT void setPictographFontFamily(const AtomicString&, UScriptCode = USCRIPT_COMMON);
125     WEBCORE_EXPORT const AtomicString& pictographFontFamily(UScriptCode = USCRIPT_COMMON) const;
126
127     WEBCORE_EXPORT static bool defaultTextAutosizingEnabled();
128     WEBCORE_EXPORT static float defaultMinimumZoomFontSize();
129
130     // Only set by Layout Tests.
131     WEBCORE_EXPORT void setMediaTypeOverride(const String&);
132     const String& mediaTypeOverride() const { return m_mediaTypeOverride; }
133
134     // Unlike areImagesEnabled, this only suppresses the network load of
135     // the image URL.  A cached image will still be rendered if requested.
136     WEBCORE_EXPORT void setLoadsImagesAutomatically(bool);
137     bool loadsImagesAutomatically() const { return m_loadsImagesAutomatically; }
138
139     // Clients that execute script should call ScriptController::canExecuteScripts()
140     // instead of this function. ScriptController::canExecuteScripts() checks the
141     // HTML sandbox, plug-in sandboxing, and other important details.
142     bool isScriptEnabled() const { return m_isScriptEnabled; }
143     WEBCORE_EXPORT void setScriptEnabled(bool);
144
145     SETTINGS_GETTERS_AND_SETTERS
146
147     WEBCORE_EXPORT void setJavaEnabled(bool);
148     bool isJavaEnabled() const { return m_isJavaEnabled; }
149
150     // This settings is only consulted if isJavaEnabled() returns true;
151     WEBCORE_EXPORT void setJavaEnabledForLocalFiles(bool);
152     bool isJavaEnabledForLocalFiles() const { return m_isJavaEnabledForLocalFiles; }
153
154     WEBCORE_EXPORT void setImagesEnabled(bool);
155     bool areImagesEnabled() const { return m_areImagesEnabled; }
156
157     WEBCORE_EXPORT void setPreferMIMETypeForImages(bool);
158     bool preferMIMETypeForImages() const { return m_preferMIMETypeForImages; }
159
160     WEBCORE_EXPORT void setPluginsEnabled(bool);
161     bool arePluginsEnabled() const { return m_arePluginsEnabled; }
162
163     WEBCORE_EXPORT void setDNSPrefetchingEnabled(bool);
164     bool dnsPrefetchingEnabled() const { return m_dnsPrefetchingEnabled; }
165
166     WEBCORE_EXPORT void setUserStyleSheetLocation(const URL&);
167     const URL& userStyleSheetLocation() const { return m_userStyleSheetLocation; }
168
169     WEBCORE_EXPORT void setNeedsAdobeFrameReloadingQuirk(bool);
170     bool needsAcrobatFrameReloadingQuirk() const { return m_needsAdobeFrameReloadingQuirk; }
171
172     WEBCORE_EXPORT void setMinimumDOMTimerInterval(std::chrono::milliseconds); // Initialized to DOMTimer::defaultMinimumInterval().
173     std::chrono::milliseconds minimumDOMTimerInterval() const { return m_minimumDOMTimerInterval; }
174
175     WEBCORE_EXPORT void setLayoutInterval(std::chrono::milliseconds);
176     std::chrono::milliseconds layoutInterval() const { return m_layoutInterval; }
177
178     bool hiddenPageDOMTimerThrottlingEnabled() const { return m_hiddenPageDOMTimerThrottlingEnabled; }
179     WEBCORE_EXPORT void setHiddenPageDOMTimerThrottlingEnabled(bool);
180     bool hiddenPageDOMTimerThrottlingAutoIncreases() const { return m_hiddenPageDOMTimerThrottlingAutoIncreases; }
181     WEBCORE_EXPORT void setHiddenPageDOMTimerThrottlingAutoIncreases(bool);
182
183     WEBCORE_EXPORT void setUsesPageCache(bool);
184     bool usesPageCache() const { return m_usesPageCache; }
185         
186     void setFontRenderingMode(FontRenderingMode mode);
187     FontRenderingMode fontRenderingMode() const;
188
189     WEBCORE_EXPORT void setShowTiledScrollingIndicator(bool);
190     bool showTiledScrollingIndicator() const { return m_showTiledScrollingIndicator; }
191
192 #if ENABLE(RESOURCE_USAGE)
193     bool resourceUsageOverlayVisible() const { return m_resourceUsageOverlayVisible; }
194     WEBCORE_EXPORT void setResourceUsageOverlayVisible(bool);
195 #endif
196
197 #if PLATFORM(WIN)
198     static void setShouldUseHighResolutionTimers(bool);
199     static bool shouldUseHighResolutionTimers() { return gShouldUseHighResolutionTimers; }
200 #endif
201
202     static bool globalConstRedeclarationShouldThrow();
203
204     WEBCORE_EXPORT void setBackgroundShouldExtendBeyondPage(bool);
205     bool backgroundShouldExtendBeyondPage() const { return m_backgroundShouldExtendBeyondPage; }
206
207 #if USE(AVFOUNDATION)
208     WEBCORE_EXPORT static void setAVFoundationEnabled(bool flag);
209     static bool isAVFoundationEnabled() { return gAVFoundationEnabled; }
210     WEBCORE_EXPORT static void setAVFoundationNSURLSessionEnabled(bool flag);
211     static bool isAVFoundationNSURLSessionEnabled() { return gAVFoundationNSURLSessionEnabled; }
212 #endif
213
214 #if PLATFORM(COCOA)
215     WEBCORE_EXPORT static void setQTKitEnabled(bool flag);
216     static bool isQTKitEnabled() { return gQTKitEnabled; }
217 #else
218     static bool isQTKitEnabled() { return false; }
219 #endif
220
221     static const unsigned defaultMaximumHTMLParserDOMTreeDepth = 512;
222     static const unsigned defaultMaximumRenderTreeDepth = 512;
223
224     WEBCORE_EXPORT static void setMockScrollbarsEnabled(bool flag);
225     WEBCORE_EXPORT static bool mockScrollbarsEnabled();
226
227     WEBCORE_EXPORT static void setUsesOverlayScrollbars(bool flag);
228     static bool usesOverlayScrollbars();
229
230     WEBCORE_EXPORT static void setUsesMockScrollAnimator(bool);
231     static bool usesMockScrollAnimator();
232
233 #if ENABLE(TOUCH_EVENTS)
234     void setTouchEventEmulationEnabled(bool enabled) { m_touchEventEmulationEnabled = enabled; }
235     bool isTouchEventEmulationEnabled() const { return m_touchEventEmulationEnabled; }
236 #endif
237
238     WEBCORE_EXPORT void setStorageBlockingPolicy(SecurityOrigin::StorageBlockingPolicy);
239     SecurityOrigin::StorageBlockingPolicy storageBlockingPolicy() const { return m_storageBlockingPolicy; }
240
241     WEBCORE_EXPORT void setScrollingPerformanceLoggingEnabled(bool);
242     bool scrollingPerformanceLoggingEnabled() { return m_scrollingPerformanceLoggingEnabled; }
243
244     WEBCORE_EXPORT static void setShouldRespectPriorityInCSSAttributeSetters(bool);
245     static bool shouldRespectPriorityInCSSAttributeSetters();
246
247     void setTimeWithoutMouseMovementBeforeHidingControls(double time) { m_timeWithoutMouseMovementBeforeHidingControls = time; }
248     double timeWithoutMouseMovementBeforeHidingControls() const { return m_timeWithoutMouseMovementBeforeHidingControls; }
249
250     bool hiddenPageCSSAnimationSuspensionEnabled() const { return m_hiddenPageCSSAnimationSuspensionEnabled; }
251     WEBCORE_EXPORT void setHiddenPageCSSAnimationSuspensionEnabled(bool);
252
253     WEBCORE_EXPORT void setFontFallbackPrefersPictographs(bool);
254     bool fontFallbackPrefersPictographs() const { return m_fontFallbackPrefersPictographs; }
255
256     WEBCORE_EXPORT void setWebFontsAlwaysFallBack(bool);
257     bool webFontsAlwaysFallBack() const { return m_webFontsAlwaysFallBack; }
258
259     static bool lowPowerVideoAudioBufferSizeEnabled() { return gLowPowerVideoAudioBufferSizeEnabled; }
260     WEBCORE_EXPORT static void setLowPowerVideoAudioBufferSizeEnabled(bool);
261
262     static bool resourceLoadStatisticsEnabled() { return gResourceLoadStatisticsEnabledEnabled; }
263     WEBCORE_EXPORT static void setResourceLoadStatisticsEnabled(bool);
264
265 #if PLATFORM(IOS)
266     WEBCORE_EXPORT static void setAudioSessionCategoryOverride(unsigned);
267     static unsigned audioSessionCategoryOverride();
268
269     WEBCORE_EXPORT static void setNetworkDataUsageTrackingEnabled(bool);
270     static bool networkDataUsageTrackingEnabled();
271
272     WEBCORE_EXPORT static void setNetworkInterfaceName(const String&);
273     static const String& networkInterfaceName();
274
275 #if HAVE(AVKIT)
276     static void setAVKitEnabled(bool flag) { gAVKitEnabled = flag; }
277 #endif
278     static bool avKitEnabled() { return gAVKitEnabled; }
279
280     static void setShouldOptOutOfNetworkStateObservation(bool flag) { gShouldOptOutOfNetworkStateObservation = flag; }
281     static bool shouldOptOutOfNetworkStateObservation() { return gShouldOptOutOfNetworkStateObservation; }
282
283     static void setShouldManageAudioSessionCategory(bool flag) { gManageAudioSession = flag; }
284     static bool shouldManageAudioSessionCategory() { return gManageAudioSession; }
285 #endif
286
287 #if ENABLE(LEGACY_ENCRYPTED_MEDIA)
288     void setMediaKeysStorageDirectory(const String& directory) { m_mediaKeysStorageDirectory = directory; }
289     const String& mediaKeysStorageDirectory() const { return m_mediaKeysStorageDirectory; }
290 #endif
291     
292 #if ENABLE(MEDIA_STREAM)
293     void setMediaDeviceIdentifierStorageDirectory(const String& directory) { m_mediaDeviceIdentifierStorageDirectory = directory; }
294     const String& mediaDeviceIdentifierStorageDirectory() const { return m_mediaDeviceIdentifierStorageDirectory; }
295
296     static bool mockCaptureDevicesEnabled();
297     WEBCORE_EXPORT static void setMockCaptureDevicesEnabled(bool);
298
299     bool mediaCaptureRequiresSecureConnection() const;
300     WEBCORE_EXPORT static void setMediaCaptureRequiresSecureConnection(bool);
301 #endif
302
303 #if ENABLE(APPLE_PAY)
304     bool applePayEnabled() const { return m_applePayEnabled; }
305     void setApplePayEnabled(bool applePayEnabled) { m_applePayEnabled = applePayEnabled; }
306
307     bool applePayCapabilityDisclosureAllowed() const { return m_applePayCapabilityDisclosureAllowed; }
308     void setApplePayCapabilityDisclosureAllowed(bool applePayCapabilityDisclosureAllowed) { m_applePayCapabilityDisclosureAllowed = applePayCapabilityDisclosureAllowed; }
309 #endif
310
311     WEBCORE_EXPORT void setForcePendingWebGLPolicy(bool);
312     bool isForcePendingWebGLPolicy() const { return m_forcePendingWebGLPolicy; }
313
314     WEBCORE_EXPORT static void setAllowsAnySSLCertificate(bool);
315     static bool allowsAnySSLCertificate();
316
317 private:
318     explicit Settings(Page*);
319
320     void initializeDefaultFontFamilies();
321
322     Page* m_page;
323
324     String m_mediaTypeOverride;
325     URL m_userStyleSheetLocation;
326     const std::unique_ptr<FontGenericFamilies> m_fontGenericFamilies;
327     SecurityOrigin::StorageBlockingPolicy m_storageBlockingPolicy;
328     std::chrono::milliseconds m_layoutInterval;
329     std::chrono::milliseconds m_minimumDOMTimerInterval;
330
331     SETTINGS_MEMBER_VARIABLES
332
333     bool m_isJavaEnabled : 1;
334     bool m_isJavaEnabledForLocalFiles : 1;
335     bool m_loadsImagesAutomatically : 1;
336     bool m_areImagesEnabled : 1;
337     bool m_preferMIMETypeForImages : 1;
338     bool m_arePluginsEnabled : 1;
339     bool m_isScriptEnabled : 1;
340     bool m_needsAdobeFrameReloadingQuirk : 1;
341     bool m_usesPageCache : 1;
342     unsigned m_fontRenderingMode : 1;
343     bool m_showTiledScrollingIndicator : 1;
344     bool m_backgroundShouldExtendBeyondPage : 1;
345     bool m_dnsPrefetchingEnabled : 1;
346
347 #if ENABLE(TOUCH_EVENTS)
348     bool m_touchEventEmulationEnabled : 1;
349 #endif
350     bool m_scrollingPerformanceLoggingEnabled : 1;
351
352     double m_timeWithoutMouseMovementBeforeHidingControls;
353
354     Timer m_setImageLoadingSettingsTimer;
355     void imageLoadingSettingsTimerFired();
356
357     bool m_hiddenPageDOMTimerThrottlingEnabled : 1;
358     bool m_hiddenPageCSSAnimationSuspensionEnabled : 1;
359     bool m_fontFallbackPrefersPictographs : 1;
360     bool m_webFontsAlwaysFallBack : 1;
361
362     bool m_forcePendingWebGLPolicy : 1;
363
364 #if ENABLE(RESOURCE_USAGE)
365     bool m_resourceUsageOverlayVisible { false };
366 #endif
367
368     bool m_hiddenPageDOMTimerThrottlingAutoIncreases { false };
369
370 #if USE(AVFOUNDATION)
371     WEBCORE_EXPORT static bool gAVFoundationEnabled;
372     WEBCORE_EXPORT static bool gAVFoundationNSURLSessionEnabled;
373 #endif
374
375 #if PLATFORM(COCOA)
376     WEBCORE_EXPORT static bool gQTKitEnabled;
377 #endif
378
379     static bool gMockScrollbarsEnabled;
380     static bool gUsesOverlayScrollbars;
381     static bool gMockScrollAnimatorEnabled;
382
383 #if PLATFORM(WIN)
384     static bool gShouldUseHighResolutionTimers;
385 #endif
386     static bool gShouldRespectPriorityInCSSAttributeSetters;
387 #if PLATFORM(IOS)
388     static bool gNetworkDataUsageTrackingEnabled;
389     WEBCORE_EXPORT static bool gAVKitEnabled;
390     WEBCORE_EXPORT static bool gShouldOptOutOfNetworkStateObservation;
391     WEBCORE_EXPORT static bool gManageAudioSession;
392 #endif
393
394 #if ENABLE(LEGACY_ENCRYPTED_MEDIA)
395     String m_mediaKeysStorageDirectory;
396 #endif
397     
398 #if ENABLE(MEDIA_STREAM)
399     String m_mediaDeviceIdentifierStorageDirectory;
400     static bool gMockCaptureDevicesEnabled;
401     static bool gMediaCaptureRequiresSecureConnection;
402 #endif
403
404 #if ENABLE(APPLE_PAY)
405     bool m_applePayEnabled { false };
406     bool m_applePayCapabilityDisclosureAllowed { true };
407 #endif
408
409     static bool gLowPowerVideoAudioBufferSizeEnabled;
410     static bool gResourceLoadStatisticsEnabledEnabled;
411     static bool gAllowsAnySSLCertificate;
412 };
413
414 } // namespace WebCore