blob: 1c216b9c73c5f28a022e3274190fb8bc8de2e348 [file] [log] [blame]
/*
* Copyright (C) 2006, 2007, 2008, 2009, 2011, 2012 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 COMPUTER, INC. ``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 COMPUTER, INC. OR
* 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.
*/
#include "config.h"
#include "Settings.h"
#include "BackForwardController.h"
#include "CachedResourceLoader.h"
#include "CookieStorage.h"
#include "DOMTimer.h"
#include "Database.h"
#include "Document.h"
#include "Frame.h"
#include "FrameTree.h"
#include "FrameView.h"
#include "HTMLMediaElement.h"
#include "HistoryItem.h"
#include "InspectorInstrumentation.h"
#include "Page.h"
#include "PageCache.h"
#include "StorageMap.h"
#include "TextAutosizer.h"
#include <limits>
using namespace std;
namespace WebCore {
static void setImageLoadingSettings(Page* page)
{
for (Frame* frame = page->mainFrame(); frame; frame = frame->tree()->traverseNext()) {
frame->document()->cachedResourceLoader()->setImagesEnabled(page->settings()->areImagesEnabled());
frame->document()->cachedResourceLoader()->setAutoLoadImages(page->settings()->loadsImagesAutomatically());
}
}
// Sets the entry in the font map for the given script. If family is the empty string, removes the entry instead.
static inline void setGenericFontFamilyMap(ScriptFontFamilyMap& fontMap, const AtomicString& family, UScriptCode script, Page* page)
{
ScriptFontFamilyMap::iterator it = fontMap.find(static_cast<int>(script));
if (family.isEmpty()) {
if (it == fontMap.end())
return;
fontMap.remove(it);
} else if (it != fontMap.end() && it->value == family)
return;
else
fontMap.set(static_cast<int>(script), family);
if (page)
page->setNeedsRecalcStyleInAllFrames();
}
static inline const AtomicString& getGenericFontFamilyForScript(const ScriptFontFamilyMap& fontMap, UScriptCode script)
{
ScriptFontFamilyMap::const_iterator it = fontMap.find(static_cast<int>(script));
if (it != fontMap.end())
return it->value;
if (script != USCRIPT_COMMON)
return getGenericFontFamilyForScript(fontMap, USCRIPT_COMMON);
return emptyAtom;
}
double Settings::gDefaultMinDOMTimerInterval = 0.010; // 10 milliseconds
double Settings::gDefaultDOMTimerAlignmentInterval = 0;
double Settings::gHiddenPageDOMTimerAlignmentInterval = 1.0;
#if USE(SAFARI_THEME)
bool Settings::gShouldPaintNativeControls = true;
#endif
#if USE(AVFOUNDATION)
bool Settings::gAVFoundationEnabled = false;
#endif
#if PLATFORM(MAC) || (PLATFORM(QT) && USE(QTKIT))
bool Settings::gQTKitEnabled = true;
#endif
bool Settings::gMockScrollbarsEnabled = false;
bool Settings::gUsesOverlayScrollbars = false;
#if PLATFORM(WIN)
bool Settings::gShouldUseHighResolutionTimers = true;
#endif
bool Settings::gShouldRespectPriorityInCSSAttributeSetters = false;
// NOTEs
// 1) EditingMacBehavior comprises Tiger, Leopard, SnowLeopard and iOS builds, as well as QtWebKit when built on Mac;
// 2) EditingWindowsBehavior comprises Win32 and WinCE builds, as well as QtWebKit and Chromium when built on Windows;
// 3) EditingUnixBehavior comprises all unix-based systems, but Darwin/MacOS (and then abusing the terminology);
// 99) MacEditingBehavior is used as a fallback.
static EditingBehaviorType editingBehaviorTypeForPlatform()
{
return
#if OS(DARWIN)
EditingMacBehavior
#elif OS(WINDOWS)
EditingWindowsBehavior
#elif OS(UNIX)
EditingUnixBehavior
#else
// Fallback
EditingMacBehavior
#endif
;
}
static const double defaultIncrementalRenderingSuppressionTimeoutInSeconds = 5;
#if USE(UNIFIED_TEXT_CHECKING)
static const bool defaultUnifiedTextCheckerEnabled = true;
#else
static const bool defaultUnifiedTextCheckerEnabled = false;
#endif
static const bool defaultSmartInsertDeleteEnabled = true;
static const bool defaultSelectTrailingWhitespaceEnabled = false;
Settings::Settings(Page* page)
: m_page(0)
, m_mediaTypeOverride("screen")
, m_storageBlockingPolicy(SecurityOrigin::AllowAllStorage)
#if ENABLE(TEXT_AUTOSIZING)
, m_textAutosizingFontScaleFactor(1)
#if HACK_FORCE_TEXT_AUTOSIZING_ON_DESKTOP
, m_textAutosizingWindowSizeOverride(320, 480)
, m_textAutosizingEnabled(true)
#else
, m_textAutosizingEnabled(false)
#endif
#endif
SETTINGS_INITIALIZER_LIST
, m_isJavaEnabled(false)
, m_isJavaEnabledForLocalFiles(true)
, m_loadsImagesAutomatically(false)
, m_privateBrowsingEnabled(false)
, m_areImagesEnabled(true)
, m_arePluginsEnabled(false)
, m_isScriptEnabled(false)
, m_needsAdobeFrameReloadingQuirk(false)
, m_usesPageCache(false)
, m_fontRenderingMode(0)
, m_isCSSCustomFilterEnabled(false)
#if ENABLE(CSS_STICKY_POSITION)
, m_cssStickyPositionEnabled(true)
#endif
#if ENABLE(CSS_VARIABLES)
, m_cssVariablesEnabled(false)
#endif
, m_showTiledScrollingIndicator(false)
, m_tiledBackingStoreEnabled(false)
, m_dnsPrefetchingEnabled(false)
#if ENABLE(TOUCH_EVENTS)
, m_touchEventEmulationEnabled(false)
#endif
, m_scrollingPerformanceLoggingEnabled(false)
, m_aggressiveTileRetentionEnabled(false)
, m_timeWithoutMouseMovementBeforeHidingControls(3)
, m_setImageLoadingSettingsTimer(this, &Settings::imageLoadingSettingsTimerFired)
#if ENABLE(HIDDEN_PAGE_DOM_TIMER_THROTTLING)
, m_hiddenPageDOMTimerThrottlingEnabled(false)
#endif
#if ENABLE(PAGE_VISIBILITY_API)
, m_hiddenPageCSSAnimationSuspensionEnabled(false)
#endif
{
// A Frame may not have been created yet, so we initialize the AtomicString
// hash before trying to use it.
AtomicString::init();
initializeDefaultFontFamilies();
m_page = page; // Page is not yet fully initialized wen constructing Settings, so keeping m_page null over initializeDefaultFontFamilies() call.
}
PassOwnPtr<Settings> Settings::create(Page* page)
{
return adoptPtr(new Settings(page));
}
SETTINGS_SETTER_BODIES
void Settings::setHiddenPageDOMTimerAlignmentInterval(double hiddenPageDOMTimerAlignmentinterval)
{
gHiddenPageDOMTimerAlignmentInterval = hiddenPageDOMTimerAlignmentinterval;
}
double Settings::hiddenPageDOMTimerAlignmentInterval()
{
return gHiddenPageDOMTimerAlignmentInterval;
}
#if !PLATFORM(MAC) && !PLATFORM(BLACKBERRY)
void Settings::initializeDefaultFontFamilies()
{
// Other platforms can set up fonts from a client, but on Mac, we want it in WebCore to share code between WebKit1 and WebKit2.
}
#endif
const AtomicString& Settings::standardFontFamily(UScriptCode script) const
{
return getGenericFontFamilyForScript(m_standardFontFamilyMap, script);
}
void Settings::setStandardFontFamily(const AtomicString& family, UScriptCode script)
{
setGenericFontFamilyMap(m_standardFontFamilyMap, family, script, m_page);
}
const AtomicString& Settings::fixedFontFamily(UScriptCode script) const
{
return getGenericFontFamilyForScript(m_fixedFontFamilyMap, script);
}
void Settings::setFixedFontFamily(const AtomicString& family, UScriptCode script)
{
setGenericFontFamilyMap(m_fixedFontFamilyMap, family, script, m_page);
}
const AtomicString& Settings::serifFontFamily(UScriptCode script) const
{
return getGenericFontFamilyForScript(m_serifFontFamilyMap, script);
}
void Settings::setSerifFontFamily(const AtomicString& family, UScriptCode script)
{
setGenericFontFamilyMap(m_serifFontFamilyMap, family, script, m_page);
}
const AtomicString& Settings::sansSerifFontFamily(UScriptCode script) const
{
return getGenericFontFamilyForScript(m_sansSerifFontFamilyMap, script);
}
void Settings::setSansSerifFontFamily(const AtomicString& family, UScriptCode script)
{
setGenericFontFamilyMap(m_sansSerifFontFamilyMap, family, script, m_page);
}
const AtomicString& Settings::cursiveFontFamily(UScriptCode script) const
{
return getGenericFontFamilyForScript(m_cursiveFontFamilyMap, script);
}
void Settings::setCursiveFontFamily(const AtomicString& family, UScriptCode script)
{
setGenericFontFamilyMap(m_cursiveFontFamilyMap, family, script, m_page);
}
const AtomicString& Settings::fantasyFontFamily(UScriptCode script) const
{
return getGenericFontFamilyForScript(m_fantasyFontFamilyMap, script);
}
void Settings::setFantasyFontFamily(const AtomicString& family, UScriptCode script)
{
setGenericFontFamilyMap(m_fantasyFontFamilyMap, family, script, m_page);
}
const AtomicString& Settings::pictographFontFamily(UScriptCode script) const
{
return getGenericFontFamilyForScript(m_pictographFontFamilyMap, script);
}
void Settings::setPictographFontFamily(const AtomicString& family, UScriptCode script)
{
setGenericFontFamilyMap(m_pictographFontFamilyMap, family, script, m_page);
}
#if ENABLE(TEXT_AUTOSIZING)
void Settings::setTextAutosizingEnabled(bool textAutosizingEnabled)
{
if (m_textAutosizingEnabled == textAutosizingEnabled)
return;
m_textAutosizingEnabled = textAutosizingEnabled;
m_page->setNeedsRecalcStyleInAllFrames();
}
void Settings::setTextAutosizingWindowSizeOverride(const IntSize& textAutosizingWindowSizeOverride)
{
if (m_textAutosizingWindowSizeOverride == textAutosizingWindowSizeOverride)
return;
m_textAutosizingWindowSizeOverride = textAutosizingWindowSizeOverride;
m_page->setNeedsRecalcStyleInAllFrames();
}
void Settings::setTextAutosizingFontScaleFactor(float fontScaleFactor)
{
m_textAutosizingFontScaleFactor = fontScaleFactor;
// FIXME: I wonder if this needs to traverse frames like in WebViewImpl::resize, or whether there is only one document per Settings instance?
for (Frame* frame = m_page->mainFrame(); frame; frame = frame->tree()->traverseNext())
frame->document()->textAutosizer()->recalculateMultipliers();
m_page->setNeedsRecalcStyleInAllFrames();
}
#endif
void Settings::setMediaTypeOverride(const String& mediaTypeOverride)
{
if (m_mediaTypeOverride == mediaTypeOverride)
return;
m_mediaTypeOverride = mediaTypeOverride;
Frame* mainFrame = m_page->mainFrame();
ASSERT(mainFrame);
FrameView* view = mainFrame->view();
ASSERT(view);
view->setMediaType(mediaTypeOverride);
m_page->setNeedsRecalcStyleInAllFrames();
}
void Settings::setLoadsImagesAutomatically(bool loadsImagesAutomatically)
{
m_loadsImagesAutomatically = loadsImagesAutomatically;
// Changing this setting to true might immediately start new loads for images that had previously had loading disabled.
// If this happens while a WebView is being dealloc'ed, and we don't know the WebView is being dealloc'ed, these new loads
// can cause crashes downstream when the WebView memory has actually been free'd.
// One example where this can happen is in Mac apps that subclass WebView then do work in their overridden dealloc methods.
// Starting these loads synchronously is not important. By putting it on a 0-delay, properly closing the Page cancels them
// before they have a chance to really start.
// See http://webkit.org/b/60572 for more discussion.
m_setImageLoadingSettingsTimer.startOneShot(0);
}
void Settings::imageLoadingSettingsTimerFired(Timer<Settings>*)
{
setImageLoadingSettings(m_page);
}
void Settings::setScriptEnabled(bool isScriptEnabled)
{
m_isScriptEnabled = isScriptEnabled;
InspectorInstrumentation::scriptsEnabled(m_page, m_isScriptEnabled);
}
void Settings::setJavaEnabled(bool isJavaEnabled)
{
m_isJavaEnabled = isJavaEnabled;
}
void Settings::setJavaEnabledForLocalFiles(bool isJavaEnabledForLocalFiles)
{
m_isJavaEnabledForLocalFiles = isJavaEnabledForLocalFiles;
}
void Settings::setImagesEnabled(bool areImagesEnabled)
{
m_areImagesEnabled = areImagesEnabled;
// See comment in setLoadsImagesAutomatically.
m_setImageLoadingSettingsTimer.startOneShot(0);
}
void Settings::setPluginsEnabled(bool arePluginsEnabled)
{
m_arePluginsEnabled = arePluginsEnabled;
}
void Settings::setPrivateBrowsingEnabled(bool privateBrowsingEnabled)
{
if (m_privateBrowsingEnabled == privateBrowsingEnabled)
return;
m_privateBrowsingEnabled = privateBrowsingEnabled;
m_page->privateBrowsingStateChanged();
}
void Settings::setUserStyleSheetLocation(const KURL& userStyleSheetLocation)
{
if (m_userStyleSheetLocation == userStyleSheetLocation)
return;
m_userStyleSheetLocation = userStyleSheetLocation;
m_page->userStyleSheetLocationChanged();
}
// FIXME: This quirk is needed because of Radar 4674537 and 5211271. We need to phase it out once Adobe
// can fix the bug from their end.
void Settings::setNeedsAdobeFrameReloadingQuirk(bool shouldNotReloadIFramesForUnchangedSRC)
{
m_needsAdobeFrameReloadingQuirk = shouldNotReloadIFramesForUnchangedSRC;
}
void Settings::setDefaultMinDOMTimerInterval(double interval)
{
gDefaultMinDOMTimerInterval = interval;
}
double Settings::defaultMinDOMTimerInterval()
{
return gDefaultMinDOMTimerInterval;
}
void Settings::setMinDOMTimerInterval(double interval)
{
m_page->setMinimumTimerInterval(interval);
}
double Settings::minDOMTimerInterval()
{
return m_page->minimumTimerInterval();
}
void Settings::setDefaultDOMTimerAlignmentInterval(double interval)
{
gDefaultDOMTimerAlignmentInterval = interval;
}
double Settings::defaultDOMTimerAlignmentInterval()
{
return gDefaultDOMTimerAlignmentInterval;
}
void Settings::setDOMTimerAlignmentInterval(double interval)
{
m_page->setTimerAlignmentInterval(interval);
}
double Settings::domTimerAlignmentInterval() const
{
return m_page->timerAlignmentInterval();
}
void Settings::setUsesPageCache(bool usesPageCache)
{
if (m_usesPageCache == usesPageCache)
return;
m_usesPageCache = usesPageCache;
if (!m_usesPageCache) {
int first = -m_page->backForward()->backCount();
int last = m_page->backForward()->forwardCount();
for (int i = first; i <= last; i++)
pageCache()->remove(m_page->backForward()->itemAtIndex(i));
}
}
void Settings::setFontRenderingMode(FontRenderingMode mode)
{
if (fontRenderingMode() == mode)
return;
m_fontRenderingMode = mode;
m_page->setNeedsRecalcStyleInAllFrames();
}
FontRenderingMode Settings::fontRenderingMode() const
{
return static_cast<FontRenderingMode>(m_fontRenderingMode);
}
#if USE(SAFARI_THEME)
void Settings::setShouldPaintNativeControls(bool shouldPaintNativeControls)
{
gShouldPaintNativeControls = shouldPaintNativeControls;
}
#endif
void Settings::setDNSPrefetchingEnabled(bool dnsPrefetchingEnabled)
{
if (m_dnsPrefetchingEnabled == dnsPrefetchingEnabled)
return;
m_dnsPrefetchingEnabled = dnsPrefetchingEnabled;
m_page->dnsPrefetchingStateChanged();
}
void Settings::setShowTiledScrollingIndicator(bool enabled)
{
if (m_showTiledScrollingIndicator == enabled)
return;
m_showTiledScrollingIndicator = enabled;
}
#if PLATFORM(WIN)
void Settings::setShouldUseHighResolutionTimers(bool shouldUseHighResolutionTimers)
{
gShouldUseHighResolutionTimers = shouldUseHighResolutionTimers;
}
#endif
void Settings::setStorageBlockingPolicy(SecurityOrigin::StorageBlockingPolicy enabled)
{
if (m_storageBlockingPolicy == enabled)
return;
m_storageBlockingPolicy = enabled;
m_page->storageBlockingStateChanged();
}
void Settings::setTiledBackingStoreEnabled(bool enabled)
{
m_tiledBackingStoreEnabled = enabled;
#if USE(TILED_BACKING_STORE)
if (m_page->mainFrame())
m_page->mainFrame()->setTiledBackingStoreEnabled(enabled);
#endif
}
#if USE(AVFOUNDATION)
void Settings::setAVFoundationEnabled(bool enabled)
{
if (gAVFoundationEnabled == enabled)
return;
gAVFoundationEnabled = enabled;
HTMLMediaElement::resetMediaEngines();
}
#endif
#if PLATFORM(MAC) || (PLATFORM(QT) && USE(QTKIT))
void Settings::setQTKitEnabled(bool enabled)
{
if (gQTKitEnabled == enabled)
return;
gQTKitEnabled = enabled;
HTMLMediaElement::resetMediaEngines();
}
#endif
void Settings::setScrollingPerformanceLoggingEnabled(bool enabled)
{
m_scrollingPerformanceLoggingEnabled = enabled;
if (m_page->mainFrame() && m_page->mainFrame()->view())
m_page->mainFrame()->view()->setScrollingPerformanceLoggingEnabled(enabled);
}
void Settings::setAggressiveTileRetentionEnabled(bool enabled)
{
m_aggressiveTileRetentionEnabled = enabled;
}
void Settings::setMockScrollbarsEnabled(bool flag)
{
gMockScrollbarsEnabled = flag;
}
bool Settings::mockScrollbarsEnabled()
{
return gMockScrollbarsEnabled;
}
void Settings::setUsesOverlayScrollbars(bool flag)
{
gUsesOverlayScrollbars = flag;
}
bool Settings::usesOverlayScrollbars()
{
return gUsesOverlayScrollbars;
}
void Settings::setShouldRespectPriorityInCSSAttributeSetters(bool flag)
{
gShouldRespectPriorityInCSSAttributeSetters = flag;
}
bool Settings::shouldRespectPriorityInCSSAttributeSetters()
{
return gShouldRespectPriorityInCSSAttributeSetters;
}
#if ENABLE(HIDDEN_PAGE_DOM_TIMER_THROTTLING)
void Settings::setHiddenPageDOMTimerThrottlingEnabled(bool flag)
{
if (m_hiddenPageDOMTimerThrottlingEnabled == flag)
return;
m_hiddenPageDOMTimerThrottlingEnabled = flag;
m_page->hiddenPageDOMTimerThrottlingStateChanged();
}
#endif
#if ENABLE(PAGE_VISIBILITY_API)
void Settings::setHiddenPageCSSAnimationSuspensionEnabled(bool flag)
{
if (m_hiddenPageCSSAnimationSuspensionEnabled == flag)
return;
m_hiddenPageCSSAnimationSuspensionEnabled = flag;
m_page->hiddenPageCSSAnimationSuspensionStateChanged();
}
#endif
} // namespace WebCore