f60096d3c27a12ae63131e905481b7b902aa20d3
[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 "ContentType.h"
31 #include "EditingBehaviorTypes.h"
32 #include "IntSize.h"
33 #include "SecurityOrigin.h"
34 #include "SettingsMacros.h"
35 #include "TextFlags.h"
36 #include "Timer.h"
37 #include "URL.h"
38 #include "WritingMode.h"
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 enum FrameFlattening {
92     FrameFlatteningDisabled,
93     FrameFlatteningEnabledForNonFullScreenIFrames,
94     FrameFlatteningFullyEnabled
95 };
96
97 typedef unsigned DebugOverlayRegions;
98
99 class Settings : public RefCounted<Settings> {
100     WTF_MAKE_NONCOPYABLE(Settings); WTF_MAKE_FAST_ALLOCATED;
101 public:
102     static Ref<Settings> create(Page*);
103     ~Settings();
104
105     void pageDestroyed() { m_page = nullptr; }
106
107     enum class ForcedAccessibilityValue { System, On, Off };
108     static const Settings::ForcedAccessibilityValue defaultForcedColorsAreInvertedAccessibilityValue = ForcedAccessibilityValue::System;
109     static const Settings::ForcedAccessibilityValue defaultForcedDisplayIsMonochromeAccessibilityValue = ForcedAccessibilityValue::System;
110     static const Settings::ForcedAccessibilityValue defaultForcedPrefersReducedMotionAccessibilityValue = ForcedAccessibilityValue::System;
111
112     WEBCORE_EXPORT void setStandardFontFamily(const AtomicString&, UScriptCode = USCRIPT_COMMON);
113     WEBCORE_EXPORT const AtomicString& standardFontFamily(UScriptCode = USCRIPT_COMMON) const;
114
115     WEBCORE_EXPORT void setFixedFontFamily(const AtomicString&, UScriptCode = USCRIPT_COMMON);
116     WEBCORE_EXPORT const AtomicString& fixedFontFamily(UScriptCode = USCRIPT_COMMON) const;
117
118     WEBCORE_EXPORT void setSerifFontFamily(const AtomicString&, UScriptCode = USCRIPT_COMMON);
119     WEBCORE_EXPORT const AtomicString& serifFontFamily(UScriptCode = USCRIPT_COMMON) const;
120
121     WEBCORE_EXPORT void setSansSerifFontFamily(const AtomicString&, UScriptCode = USCRIPT_COMMON);
122     WEBCORE_EXPORT const AtomicString& sansSerifFontFamily(UScriptCode = USCRIPT_COMMON) const;
123
124     WEBCORE_EXPORT void setCursiveFontFamily(const AtomicString&, UScriptCode = USCRIPT_COMMON);
125     WEBCORE_EXPORT const AtomicString& cursiveFontFamily(UScriptCode = USCRIPT_COMMON) const;
126
127     WEBCORE_EXPORT void setFantasyFontFamily(const AtomicString&, UScriptCode = USCRIPT_COMMON);
128     WEBCORE_EXPORT const AtomicString& fantasyFontFamily(UScriptCode = USCRIPT_COMMON) const;
129
130     WEBCORE_EXPORT void setPictographFontFamily(const AtomicString&, UScriptCode = USCRIPT_COMMON);
131     WEBCORE_EXPORT const AtomicString& pictographFontFamily(UScriptCode = USCRIPT_COMMON) const;
132
133     WEBCORE_EXPORT static bool defaultTextAutosizingEnabled();
134     WEBCORE_EXPORT static float defaultMinimumZoomFontSize();
135
136     // Only set by Layout Tests.
137     WEBCORE_EXPORT void setMediaTypeOverride(const String&);
138     const String& mediaTypeOverride() const { return m_mediaTypeOverride; }
139
140     // Unlike areImagesEnabled, this only suppresses the network load of
141     // the image URL.  A cached image will still be rendered if requested.
142     WEBCORE_EXPORT void setLoadsImagesAutomatically(bool);
143     bool loadsImagesAutomatically() const { return m_loadsImagesAutomatically; }
144
145     // Clients that execute script should call ScriptController::canExecuteScripts()
146     // instead of this function. ScriptController::canExecuteScripts() checks the
147     // HTML sandbox, plug-in sandboxing, and other important details.
148     bool isScriptEnabled() const { return m_isScriptEnabled; }
149     WEBCORE_EXPORT void setScriptEnabled(bool);
150
151     SETTINGS_GETTERS_AND_SETTERS
152
153     WEBCORE_EXPORT void setJavaEnabled(bool);
154     bool isJavaEnabled() const { return m_isJavaEnabled; }
155
156     // This settings is only consulted if isJavaEnabled() returns true;
157     WEBCORE_EXPORT void setJavaEnabledForLocalFiles(bool);
158     bool isJavaEnabledForLocalFiles() const { return m_isJavaEnabledForLocalFiles; }
159
160     WEBCORE_EXPORT void setImagesEnabled(bool);
161     bool areImagesEnabled() const { return m_areImagesEnabled; }
162
163     WEBCORE_EXPORT void setPreferMIMETypeForImages(bool);
164     bool preferMIMETypeForImages() const { return m_preferMIMETypeForImages; }
165
166     WEBCORE_EXPORT void setPluginsEnabled(bool);
167     bool arePluginsEnabled() const { return m_arePluginsEnabled; }
168
169     WEBCORE_EXPORT void setDNSPrefetchingEnabled(bool);
170     bool dnsPrefetchingEnabled() const { return m_dnsPrefetchingEnabled; }
171
172     WEBCORE_EXPORT void setUserStyleSheetLocation(const URL&);
173     const URL& userStyleSheetLocation() const { return m_userStyleSheetLocation; }
174
175     WEBCORE_EXPORT void setNeedsAdobeFrameReloadingQuirk(bool);
176     bool needsAcrobatFrameReloadingQuirk() const { return m_needsAdobeFrameReloadingQuirk; }
177
178     WEBCORE_EXPORT void setMinimumDOMTimerInterval(Seconds); // Initialized to DOMTimer::defaultMinimumInterval().
179     Seconds minimumDOMTimerInterval() const { return m_minimumDOMTimerInterval; }
180
181     WEBCORE_EXPORT void setLayoutInterval(Seconds);
182     Seconds layoutInterval() const { return m_layoutInterval; }
183
184     bool hiddenPageDOMTimerThrottlingEnabled() const { return m_hiddenPageDOMTimerThrottlingEnabled; }
185     WEBCORE_EXPORT void setHiddenPageDOMTimerThrottlingEnabled(bool);
186     bool hiddenPageDOMTimerThrottlingAutoIncreases() const { return m_hiddenPageDOMTimerThrottlingAutoIncreases; }
187     WEBCORE_EXPORT void setHiddenPageDOMTimerThrottlingAutoIncreases(bool);
188
189     WEBCORE_EXPORT void setUsesPageCache(bool);
190     bool usesPageCache() const { return m_usesPageCache; }
191         
192     void setFontRenderingMode(FontRenderingMode mode);
193     FontRenderingMode fontRenderingMode() const;
194
195     WEBCORE_EXPORT void setShowTiledScrollingIndicator(bool);
196     bool showTiledScrollingIndicator() const { return m_showTiledScrollingIndicator; }
197
198 #if ENABLE(RESOURCE_USAGE)
199     bool resourceUsageOverlayVisible() const { return m_resourceUsageOverlayVisible; }
200     WEBCORE_EXPORT void setResourceUsageOverlayVisible(bool);
201 #endif
202
203 #if PLATFORM(WIN)
204     static void setShouldUseHighResolutionTimers(bool);
205     static bool shouldUseHighResolutionTimers() { return gShouldUseHighResolutionTimers; }
206 #endif
207
208     static bool isPostLoadCPUUsageMeasurementEnabled();
209     static bool isPostBackgroundingCPUUsageMeasurementEnabled();
210     static bool isPerActivityStateCPUUsageMeasurementEnabled();
211
212     static bool isPostLoadMemoryUsageMeasurementEnabled();
213     static bool isPostBackgroundingMemoryUsageMeasurementEnabled();
214
215     static bool globalConstRedeclarationShouldThrow();
216
217     WEBCORE_EXPORT void setBackgroundShouldExtendBeyondPage(bool);
218     bool backgroundShouldExtendBeyondPage() const { return m_backgroundShouldExtendBeyondPage; }
219
220 #if USE(AVFOUNDATION)
221     WEBCORE_EXPORT static void setAVFoundationEnabled(bool flag);
222     static bool isAVFoundationEnabled() { return gAVFoundationEnabled; }
223     WEBCORE_EXPORT static void setAVFoundationNSURLSessionEnabled(bool flag);
224     static bool isAVFoundationNSURLSessionEnabled() { return gAVFoundationNSURLSessionEnabled; }
225 #endif
226
227 #if PLATFORM(COCOA)
228     WEBCORE_EXPORT static void setQTKitEnabled(bool flag);
229     static bool isQTKitEnabled() { return gQTKitEnabled; }
230 #else
231     static bool isQTKitEnabled() { return false; }
232 #endif
233
234 #if USE(GSTREAMER)
235     WEBCORE_EXPORT static void setGStreamerEnabled(bool flag);
236     static bool isGStreamerEnabled() { return gGStreamerEnabled; }
237 #endif
238
239     static const unsigned defaultMaximumHTMLParserDOMTreeDepth = 512;
240     static const unsigned defaultMaximumRenderTreeDepth = 512;
241
242     WEBCORE_EXPORT static void setMockScrollbarsEnabled(bool flag);
243     WEBCORE_EXPORT static bool mockScrollbarsEnabled();
244
245     WEBCORE_EXPORT static void setUsesOverlayScrollbars(bool flag);
246     static bool usesOverlayScrollbars();
247
248     WEBCORE_EXPORT static void setUsesMockScrollAnimator(bool);
249     static bool usesMockScrollAnimator();
250
251 #if ENABLE(TOUCH_EVENTS)
252     void setTouchEventEmulationEnabled(bool enabled) { m_touchEventEmulationEnabled = enabled; }
253     bool isTouchEventEmulationEnabled() const { return m_touchEventEmulationEnabled; }
254 #endif
255
256     WEBCORE_EXPORT void setStorageBlockingPolicy(SecurityOrigin::StorageBlockingPolicy);
257     SecurityOrigin::StorageBlockingPolicy storageBlockingPolicy() const { return m_storageBlockingPolicy; }
258
259     WEBCORE_EXPORT void setScrollingPerformanceLoggingEnabled(bool);
260     bool scrollingPerformanceLoggingEnabled() { return m_scrollingPerformanceLoggingEnabled; }
261
262     WEBCORE_EXPORT static void setShouldRespectPriorityInCSSAttributeSetters(bool);
263     static bool shouldRespectPriorityInCSSAttributeSetters();
264
265     void setTimeWithoutMouseMovementBeforeHidingControls(Seconds time) { m_timeWithoutMouseMovementBeforeHidingControls = time; }
266     Seconds timeWithoutMouseMovementBeforeHidingControls() const { return m_timeWithoutMouseMovementBeforeHidingControls; }
267
268     bool hiddenPageCSSAnimationSuspensionEnabled() const { return m_hiddenPageCSSAnimationSuspensionEnabled; }
269     WEBCORE_EXPORT void setHiddenPageCSSAnimationSuspensionEnabled(bool);
270
271     WEBCORE_EXPORT void setFontFallbackPrefersPictographs(bool);
272     bool fontFallbackPrefersPictographs() const { return m_fontFallbackPrefersPictographs; }
273
274     WEBCORE_EXPORT void setWebFontsAlwaysFallBack(bool);
275     bool webFontsAlwaysFallBack() const { return m_webFontsAlwaysFallBack; }
276
277     static bool lowPowerVideoAudioBufferSizeEnabled() { return gLowPowerVideoAudioBufferSizeEnabled; }
278     WEBCORE_EXPORT static void setLowPowerVideoAudioBufferSizeEnabled(bool);
279
280     static bool resourceLoadStatisticsEnabled() { return gResourceLoadStatisticsEnabledEnabled; }
281     WEBCORE_EXPORT static void setResourceLoadStatisticsEnabled(bool);
282
283 #if PLATFORM(IOS)
284     WEBCORE_EXPORT static void setAudioSessionCategoryOverride(unsigned);
285     static unsigned audioSessionCategoryOverride();
286
287     WEBCORE_EXPORT static void setNetworkDataUsageTrackingEnabled(bool);
288     static bool networkDataUsageTrackingEnabled();
289
290     WEBCORE_EXPORT static void setNetworkInterfaceName(const String&);
291     static const String& networkInterfaceName();
292
293 #if HAVE(AVKIT)
294     static void setAVKitEnabled(bool flag) { gAVKitEnabled = flag; }
295 #endif
296     static bool avKitEnabled() { return gAVKitEnabled; }
297
298     static void setShouldOptOutOfNetworkStateObservation(bool flag) { gShouldOptOutOfNetworkStateObservation = flag; }
299     static bool shouldOptOutOfNetworkStateObservation() { return gShouldOptOutOfNetworkStateObservation; }
300 #endif
301
302 #if USE(AUDIO_SESSION)
303     static void setShouldManageAudioSessionCategory(bool flag) { gManageAudioSession = flag; }
304     static bool shouldManageAudioSessionCategory() { return gManageAudioSession; }
305 #endif
306
307     static void setCustomPasteboardDataEnabled(bool enabled) { gCustomPasteboardDataEnabled = enabled; }
308     WEBCORE_EXPORT static bool customPasteboardDataEnabled();
309
310 #if ENABLE(LEGACY_ENCRYPTED_MEDIA)
311     void setMediaKeysStorageDirectory(const String& directory) { m_mediaKeysStorageDirectory = directory; }
312     const String& mediaKeysStorageDirectory() const { return m_mediaKeysStorageDirectory; }
313 #endif
314     
315 #if ENABLE(MEDIA_STREAM)
316     void setMediaDeviceIdentifierStorageDirectory(const String& directory) { m_mediaDeviceIdentifierStorageDirectory = directory; }
317     const String& mediaDeviceIdentifierStorageDirectory() const { return m_mediaDeviceIdentifierStorageDirectory; }
318
319     static bool mockCaptureDevicesEnabled();
320     WEBCORE_EXPORT static void setMockCaptureDevicesEnabled(bool);
321
322     bool mediaCaptureRequiresSecureConnection() const;
323     WEBCORE_EXPORT static void setMediaCaptureRequiresSecureConnection(bool);
324 #endif
325
326 #if ENABLE(APPLE_PAY)
327     bool applePayEnabled() const { return m_applePayEnabled; }
328     void setApplePayEnabled(bool applePayEnabled) { m_applePayEnabled = applePayEnabled; }
329
330     bool applePayCapabilityDisclosureAllowed() const { return m_applePayCapabilityDisclosureAllowed; }
331     void setApplePayCapabilityDisclosureAllowed(bool applePayCapabilityDisclosureAllowed) { m_applePayCapabilityDisclosureAllowed = applePayCapabilityDisclosureAllowed; }
332 #endif
333
334     WEBCORE_EXPORT void setForcePendingWebGLPolicy(bool);
335     bool isForcePendingWebGLPolicy() const { return m_forcePendingWebGLPolicy; }
336
337     WEBCORE_EXPORT static void setAllowsAnySSLCertificate(bool);
338     static bool allowsAnySSLCertificate();
339
340     WEBCORE_EXPORT static const String& defaultMediaContentTypesRequiringHardwareSupport();
341     WEBCORE_EXPORT void setMediaContentTypesRequiringHardwareSupport(const Vector<ContentType>&);
342     WEBCORE_EXPORT void setMediaContentTypesRequiringHardwareSupport(const String&);
343     const Vector<ContentType>& mediaContentTypesRequiringHardwareSupport() const { return m_mediaContentTypesRequiringHardwareSupport; }
344
345 private:
346     explicit Settings(Page*);
347
348     void initializeDefaultFontFamilies();
349
350     Page* m_page;
351
352     String m_mediaTypeOverride;
353     URL m_userStyleSheetLocation;
354     const std::unique_ptr<FontGenericFamilies> m_fontGenericFamilies;
355     SecurityOrigin::StorageBlockingPolicy m_storageBlockingPolicy;
356     Seconds m_layoutInterval;
357     Seconds m_minimumDOMTimerInterval;
358
359     SETTINGS_MEMBER_VARIABLES
360
361     bool m_isJavaEnabled : 1;
362     bool m_isJavaEnabledForLocalFiles : 1;
363     bool m_loadsImagesAutomatically : 1;
364     bool m_areImagesEnabled : 1;
365     bool m_preferMIMETypeForImages : 1;
366     bool m_arePluginsEnabled : 1;
367     bool m_isScriptEnabled : 1;
368     bool m_needsAdobeFrameReloadingQuirk : 1;
369     bool m_usesPageCache : 1;
370     unsigned m_fontRenderingMode : 1;
371     bool m_showTiledScrollingIndicator : 1;
372     bool m_backgroundShouldExtendBeyondPage : 1;
373     bool m_dnsPrefetchingEnabled : 1;
374
375 #if ENABLE(TOUCH_EVENTS)
376     bool m_touchEventEmulationEnabled : 1;
377 #endif
378     bool m_scrollingPerformanceLoggingEnabled : 1;
379
380     Seconds m_timeWithoutMouseMovementBeforeHidingControls;
381
382     Timer m_setImageLoadingSettingsTimer;
383     void imageLoadingSettingsTimerFired();
384
385     bool m_hiddenPageDOMTimerThrottlingEnabled : 1;
386     bool m_hiddenPageCSSAnimationSuspensionEnabled : 1;
387     bool m_fontFallbackPrefersPictographs : 1;
388     bool m_webFontsAlwaysFallBack : 1;
389
390     bool m_forcePendingWebGLPolicy : 1;
391
392 #if ENABLE(RESOURCE_USAGE)
393     bool m_resourceUsageOverlayVisible { false };
394 #endif
395
396     bool m_hiddenPageDOMTimerThrottlingAutoIncreases { false };
397
398 #if USE(AVFOUNDATION)
399     WEBCORE_EXPORT static bool gAVFoundationEnabled;
400     WEBCORE_EXPORT static bool gAVFoundationNSURLSessionEnabled;
401 #endif
402
403 #if PLATFORM(COCOA)
404     WEBCORE_EXPORT static bool gQTKitEnabled;
405 #endif
406
407 #if USE(GSTREAMER)
408     WEBCORE_EXPORT static bool gGStreamerEnabled;
409 #endif
410
411     static bool gMockScrollbarsEnabled;
412     static bool gUsesOverlayScrollbars;
413     static bool gMockScrollAnimatorEnabled;
414
415 #if PLATFORM(WIN)
416     static bool gShouldUseHighResolutionTimers;
417 #endif
418     static bool gShouldRespectPriorityInCSSAttributeSetters;
419 #if PLATFORM(IOS)
420     static bool gNetworkDataUsageTrackingEnabled;
421     WEBCORE_EXPORT static bool gAVKitEnabled;
422     WEBCORE_EXPORT static bool gShouldOptOutOfNetworkStateObservation;
423 #endif
424     WEBCORE_EXPORT static bool gManageAudioSession;
425     WEBCORE_EXPORT static bool gCustomPasteboardDataEnabled;
426
427 #if ENABLE(LEGACY_ENCRYPTED_MEDIA)
428     String m_mediaKeysStorageDirectory;
429 #endif
430     
431 #if ENABLE(MEDIA_STREAM)
432     String m_mediaDeviceIdentifierStorageDirectory;
433     static bool gMockCaptureDevicesEnabled;
434     static bool gMediaCaptureRequiresSecureConnection;
435 #endif
436
437 #if ENABLE(APPLE_PAY)
438     bool m_applePayEnabled { false };
439     bool m_applePayCapabilityDisclosureAllowed { true };
440 #endif
441
442     static bool gLowPowerVideoAudioBufferSizeEnabled;
443     static bool gResourceLoadStatisticsEnabledEnabled;
444     static bool gAllowsAnySSLCertificate;
445
446     Vector<ContentType> m_mediaContentTypesRequiringHardwareSupport;
447 };
448
449 inline bool Settings::isPostLoadCPUUsageMeasurementEnabled()
450 {
451 #if PLATFORM(COCOA)
452     return true;
453 #else
454     return false;
455 #endif
456 }
457
458 inline bool Settings::isPostBackgroundingCPUUsageMeasurementEnabled()
459 {
460 #if PLATFORM(MAC)
461     return true;
462 #else
463     return false;
464 #endif
465 }
466
467 inline bool Settings::isPerActivityStateCPUUsageMeasurementEnabled()
468 {
469 #if PLATFORM(MAC)
470     return true;
471 #else
472     return false;
473 #endif
474 }
475
476 inline bool Settings::isPostLoadMemoryUsageMeasurementEnabled()
477 {
478 #if PLATFORM(COCOA)
479     return true;
480 #else
481     return false;
482 #endif
483 }
484
485 inline bool Settings::isPostBackgroundingMemoryUsageMeasurementEnabled()
486 {
487 #if PLATFORM(MAC)
488     return true;
489 #else
490     return false;
491 #endif
492 }
493
494 } // namespace WebCore