Regression(r211455): ASSERTION FAILED: frameView || pageCacheState() == InPageCache...
[WebKit-https.git] / Source / WebCore / dom / Document.cpp
1 /*
2  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
3  *           (C) 1999 Antti Koivisto (koivisto@kde.org)
4  *           (C) 2001 Dirk Mueller (mueller@kde.org)
5  *           (C) 2006 Alexey Proskuryakov (ap@webkit.org)
6  * Copyright (C) 2004-2017 Apple Inc. All rights reserved.
7  * Copyright (C) 2008, 2009 Torch Mobile Inc. All rights reserved. (http://www.torchmobile.com/)
8  * Copyright (C) 2008, 2009, 2011, 2012 Google Inc. All rights reserved.
9  * Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies)
10  * Copyright (C) Research In Motion Limited 2010-2011. All rights reserved.
11  *
12  * This library is free software; you can redistribute it and/or
13  * modify it under the terms of the GNU Library General Public
14  * License as published by the Free Software Foundation; either
15  * version 2 of the License, or (at your option) any later version.
16  *
17  * This library is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
20  * Library General Public License for more details.
21  *
22  * You should have received a copy of the GNU Library General Public License
23  * along with this library; see the file COPYING.LIB.  If not, write to
24  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
25  * Boston, MA 02110-1301, USA.
26  */
27
28 #include "config.h"
29 #include "Document.h"
30
31 #include "AXObjectCache.h"
32 #include "Attr.h"
33 #include "CDATASection.h"
34 #include "CSSAnimationController.h"
35 #include "CSSFontSelector.h"
36 #include "CSSStyleDeclaration.h"
37 #include "CSSStyleSheet.h"
38 #include "CachedCSSStyleSheet.h"
39 #include "CachedFrame.h"
40 #include "CachedResourceLoader.h"
41 #include "Chrome.h"
42 #include "ChromeClient.h"
43 #include "Comment.h"
44 #include "CommonVM.h"
45 #include "CompositionEvent.h"
46 #include "ContentSecurityPolicy.h"
47 #include "CookieJar.h"
48 #include "CustomElementReactionQueue.h"
49 #include "CustomElementRegistry.h"
50 #include "CustomEvent.h"
51 #include "DOMImplementation.h"
52 #include "DOMNamedFlowCollection.h"
53 #include "DOMWindow.h"
54 #include "DateComponents.h"
55 #include "DebugPageOverlays.h"
56 #include "DocumentLoader.h"
57 #include "DocumentMarkerController.h"
58 #include "DocumentSharedObjectPool.h"
59 #include "DocumentType.h"
60 #include "Editor.h"
61 #include "ElementIterator.h"
62 #include "EventHandler.h"
63 #include "ExtensionStyleSheets.h"
64 #include "FocusController.h"
65 #include "FontFaceSet.h"
66 #include "FormController.h"
67 #include "FrameLoader.h"
68 #include "FrameLoaderClient.h"
69 #include "FrameView.h"
70 #include "GenericCachedHTMLCollection.h"
71 #include "HTMLAllCollection.h"
72 #include "HTMLAnchorElement.h"
73 #include "HTMLBaseElement.h"
74 #include "HTMLBodyElement.h"
75 #include "HTMLCanvasElement.h"
76 #include "HTMLDocument.h"
77 #include "HTMLElementFactory.h"
78 #include "HTMLFormControlElement.h"
79 #include "HTMLFrameOwnerElement.h"
80 #include "HTMLFrameSetElement.h"
81 #include "HTMLHeadElement.h"
82 #include "HTMLHtmlElement.h"
83 #include "HTMLImageElement.h"
84 #include "HTMLInputElement.h"
85 #include "HTMLLinkElement.h"
86 #include "HTMLMediaElement.h"
87 #include "HTMLNameCollection.h"
88 #include "HTMLParserIdioms.h"
89 #include "HTMLPictureElement.h"
90 #include "HTMLPlugInElement.h"
91 #include "HTMLScriptElement.h"
92 #include "HTMLStyleElement.h"
93 #include "HTMLTitleElement.h"
94 #include "HTMLUnknownElement.h"
95 #include "HTTPHeaderNames.h"
96 #include "HTTPParsers.h"
97 #include "HashChangeEvent.h"
98 #include "History.h"
99 #include "HitTestResult.h"
100 #include "IconController.h"
101 #include "ImageLoader.h"
102 #include "InspectorInstrumentation.h"
103 #include "JSCustomElementInterface.h"
104 #include "JSLazyEventListener.h"
105 #include "KeyboardEvent.h"
106 #include "Language.h"
107 #include "LoaderStrategy.h"
108 #include "Logging.h"
109 #include "MainFrame.h"
110 #include "MediaCanStartListener.h"
111 #include "MediaProducer.h"
112 #include "MediaQueryList.h"
113 #include "MediaQueryMatcher.h"
114 #include "MessageEvent.h"
115 #include "MouseEventWithHitTestResults.h"
116 #include "MutationEvent.h"
117 #include "NameNodeList.h"
118 #include "NamedFlowCollection.h"
119 #include "NestingLevelIncrementer.h"
120 #include "NoEventDispatchAssertion.h"
121 #include "NodeIterator.h"
122 #include "NodeRareData.h"
123 #include "NodeWithIndex.h"
124 #include "OriginAccessEntry.h"
125 #include "OverflowEvent.h"
126 #include "PageConsoleClient.h"
127 #include "PageGroup.h"
128 #include "PageTransitionEvent.h"
129 #include "PlatformLocale.h"
130 #include "PlatformMediaSessionManager.h"
131 #include "PlatformScreen.h"
132 #include "PlatformStrategies.h"
133 #include "PlugInsResources.h"
134 #include "PluginDocument.h"
135 #include "PointerLockController.h"
136 #include "PopStateEvent.h"
137 #include "ProcessingInstruction.h"
138 #include "RenderChildIterator.h"
139 #include "RenderLayerCompositor.h"
140 #include "RenderTreeUpdater.h"
141 #include "RenderView.h"
142 #include "RenderWidget.h"
143 #include "RequestAnimationFrameCallback.h"
144 #include "ResourceLoadObserver.h"
145 #include "RuntimeEnabledFeatures.h"
146 #include "SVGDocumentExtensions.h"
147 #include "SVGElement.h"
148 #include "SVGElementFactory.h"
149 #include "SVGNames.h"
150 #include "SVGSVGElement.h"
151 #include "SVGTitleElement.h"
152 #include "SVGZoomEvent.h"
153 #include "SchemeRegistry.h"
154 #include "ScopedEventQueue.h"
155 #include "ScriptController.h"
156 #include "ScriptModuleLoader.h"
157 #include "ScriptRunner.h"
158 #include "ScriptSourceCode.h"
159 #include "ScriptedAnimationController.h"
160 #include "ScrollingCoordinator.h"
161 #include "SecurityOrigin.h"
162 #include "SecurityOriginData.h"
163 #include "SecurityOriginPolicy.h"
164 #include "SecurityPolicy.h"
165 #include "SegmentedString.h"
166 #include "SelectorQuery.h"
167 #include "Settings.h"
168 #include "ShadowRoot.h"
169 #include "SocketProvider.h"
170 #include "StorageEvent.h"
171 #include "StyleProperties.h"
172 #include "StyleResolveForDocument.h"
173 #include "StyleResolver.h"
174 #include "StyleScope.h"
175 #include "StyleSheetContents.h"
176 #include "StyleSheetList.h"
177 #include "StyleTreeResolver.h"
178 #include "SubresourceLoader.h"
179 #include "TextAutoSizing.h"
180 #include "TextEvent.h"
181 #include "TextNodeTraversal.h"
182 #include "TransformSource.h"
183 #include "TreeWalker.h"
184 #include "ValidationMessageClient.h"
185 #include "VisitedLinkState.h"
186 #include "WheelEvent.h"
187 #include "WindowFeatures.h"
188 #include "XMLDocument.h"
189 #include "XMLDocumentParser.h"
190 #include "XMLNSNames.h"
191 #include "XMLNames.h"
192 #include "XPathEvaluator.h"
193 #include "XPathExpression.h"
194 #include "XPathNSResolver.h"
195 #include "XPathResult.h"
196 #include "htmlediting.h"
197 #include <ctime>
198 #include <inspector/ScriptCallStack.h>
199 #include <wtf/CurrentTime.h>
200 #include <wtf/NeverDestroyed.h>
201 #include <wtf/SetForScope.h>
202 #include <wtf/SystemTracing.h>
203 #include <wtf/text/StringBuffer.h>
204 #include <yarr/RegularExpression.h>
205
206 #if ENABLE(DEVICE_ORIENTATION)
207 #include "DeviceMotionEvent.h"
208 #include "DeviceOrientationEvent.h"
209 #endif
210
211 #if ENABLE(FULLSCREEN_API)
212 #include "RenderFullScreen.h"
213 #endif
214
215 #if ENABLE(INDEXED_DATABASE)
216 #include "IDBConnectionProxy.h"
217 #include "IDBOpenDBRequest.h"
218 #endif
219
220 #if PLATFORM(IOS)
221 #include "CSSFontSelector.h"
222 #include "DeviceMotionClientIOS.h"
223 #include "DeviceMotionController.h"
224 #include "DeviceOrientationClientIOS.h"
225 #include "DeviceOrientationController.h"
226 #include "Geolocation.h"
227 #include "Navigator.h"
228 #include "NavigatorGeolocation.h"
229 #include "WKContentObservation.h"
230 #include "WebCoreSystemInterface.h"
231 #endif
232
233 #if ENABLE(IOS_GESTURE_EVENTS)
234 #include "GestureEvent.h"
235 #endif
236
237 #if ENABLE(MATHML)
238 #include "MathMLElement.h"
239 #include "MathMLElementFactory.h"
240 #include "MathMLNames.h"
241 #endif
242
243 #if ENABLE(MEDIA_SESSION)
244 #include "MediaSession.h"
245 #endif
246
247 #if USE(QUICK_LOOK)
248 #include "QuickLook.h"
249 #endif
250
251 #if ENABLE(TOUCH_EVENTS)
252 #include "TouchEvent.h"
253 #include "TouchList.h"
254 #endif
255
256 #if ENABLE(VIDEO_TRACK)
257 #include "CaptionUserPreferences.h"
258 #endif
259
260 #if ENABLE(WEB_REPLAY)
261 #include "WebReplayInputs.h"
262 #include <replay/EmptyInputCursor.h>
263 #include <replay/InputCursor.h>
264 #endif
265
266 #if ENABLE(WIRELESS_PLAYBACK_TARGET)
267 #include "MediaPlaybackTargetClient.h"
268 #endif
269
270 #if ENABLE(XSLT)
271 #include "XSLTProcessor.h"
272 #endif
273
274 using namespace WTF;
275 using namespace Unicode;
276
277 namespace WebCore {
278
279 using namespace HTMLNames;
280
281 static const unsigned cMaxWriteRecursionDepth = 21;
282 bool Document::hasEverCreatedAnAXObjectCache = false;
283
284 // DOM Level 2 says (letters added):
285 //
286 // a) Name start characters must have one of the categories Ll, Lu, Lo, Lt, Nl.
287 // b) Name characters other than Name-start characters must have one of the categories Mc, Me, Mn, Lm, or Nd.
288 // c) Characters in the compatibility area (i.e. with character code greater than #xF900 and less than #xFFFE) are not allowed in XML names.
289 // d) Characters which have a font or compatibility decomposition (i.e. those with a "compatibility formatting tag" in field 5 of the database -- marked by field 5 beginning with a "<") are not allowed.
290 // e) The following characters are treated as name-start characters rather than name characters, because the property file classifies them as Alphabetic: [#x02BB-#x02C1], #x0559, #x06E5, #x06E6.
291 // f) Characters #x20DD-#x20E0 are excluded (in accordance with Unicode, section 5.14).
292 // g) Character #x00B7 is classified as an extender, because the property list so identifies it.
293 // h) Character #x0387 is added as a name character, because #x00B7 is its canonical equivalent.
294 // i) Characters ':' and '_' are allowed as name-start characters.
295 // j) Characters '-' and '.' are allowed as name characters.
296 //
297 // It also contains complete tables. If we decide it's better, we could include those instead of the following code.
298
299 static inline bool isValidNameStart(UChar32 c)
300 {
301     // rule (e) above
302     if ((c >= 0x02BB && c <= 0x02C1) || c == 0x559 || c == 0x6E5 || c == 0x6E6)
303         return true;
304
305     // rule (i) above
306     if (c == ':' || c == '_')
307         return true;
308
309     // rules (a) and (f) above
310     if (!(U_GET_GC_MASK(c) & (U_GC_LL_MASK | U_GC_LU_MASK | U_GC_LO_MASK | U_GC_LT_MASK | U_GC_NL_MASK)))
311         return false;
312
313     // rule (c) above
314     if (c >= 0xF900 && c < 0xFFFE)
315         return false;
316
317     // rule (d) above
318     int type = u_getIntPropertyValue(c, UCHAR_DECOMPOSITION_TYPE);
319     if (type == U_DT_FONT || type == U_DT_COMPAT)
320         return false;
321
322     return true;
323 }
324
325 static inline bool isValidNamePart(UChar32 c)
326 {
327     // rules (a), (e), and (i) above
328     if (isValidNameStart(c))
329         return true;
330
331     // rules (g) and (h) above
332     if (c == 0x00B7 || c == 0x0387)
333         return true;
334
335     // rule (j) above
336     if (c == '-' || c == '.')
337         return true;
338
339     // rules (b) and (f) above
340     if (!(U_GET_GC_MASK(c) & (U_GC_M_MASK | U_GC_LM_MASK | U_GC_ND_MASK)))
341         return false;
342
343     // rule (c) above
344     if (c >= 0xF900 && c < 0xFFFE)
345         return false;
346
347     // rule (d) above
348     int type = u_getIntPropertyValue(c, UCHAR_DECOMPOSITION_TYPE);
349     if (type == U_DT_FONT || type == U_DT_COMPAT)
350         return false;
351
352     return true;
353 }
354
355 static Widget* widgetForElement(Element* focusedElement)
356 {
357     if (!focusedElement)
358         return nullptr;
359     auto* renderer = focusedElement->renderer();
360     if (!is<RenderWidget>(renderer))
361         return nullptr;
362     return downcast<RenderWidget>(*renderer).widget();
363 }
364
365 static bool acceptsEditingFocus(Node* node)
366 {
367     ASSERT(node);
368     ASSERT(node->hasEditableStyle());
369
370     Node* root = node->rootEditableElement();
371     Frame* frame = node->document().frame();
372     if (!frame || !root)
373         return false;
374
375     return frame->editor().shouldBeginEditing(rangeOfContents(*root).ptr());
376 }
377
378 static bool canAccessAncestor(const SecurityOrigin& activeSecurityOrigin, Frame* targetFrame)
379 {
380     // targetFrame can be 0 when we're trying to navigate a top-level frame
381     // that has a 0 opener.
382     if (!targetFrame)
383         return false;
384
385     const bool isLocalActiveOrigin = activeSecurityOrigin.isLocal();
386     for (Frame* ancestorFrame = targetFrame; ancestorFrame; ancestorFrame = ancestorFrame->tree().parent()) {
387         Document* ancestorDocument = ancestorFrame->document();
388         // FIXME: Should be an ASSERT? Frames should alway have documents.
389         if (!ancestorDocument)
390             return true;
391
392         const SecurityOrigin& ancestorSecurityOrigin = ancestorDocument->securityOrigin();
393         if (activeSecurityOrigin.canAccess(ancestorSecurityOrigin))
394             return true;
395         
396         // Allow file URL descendant navigation even when allowFileAccessFromFileURLs is false.
397         // FIXME: It's a bit strange to special-case local origins here. Should we be doing
398         // something more general instead?
399         if (isLocalActiveOrigin && ancestorSecurityOrigin.isLocal())
400             return true;
401     }
402
403     return false;
404 }
405
406 static void printNavigationErrorMessage(Frame* frame, const URL& activeURL, const char* reason)
407 {
408     String message = "Unsafe JavaScript attempt to initiate navigation for frame with URL '" + frame->document()->url().string() + "' from frame with URL '" + activeURL.string() + "'. " + reason + "\n";
409
410     // FIXME: should we print to the console of the document performing the navigation instead?
411     frame->document()->domWindow()->printErrorMessage(message);
412 }
413
414 #if ENABLE(TEXT_AUTOSIZING)
415
416 void TextAutoSizingTraits::constructDeletedValue(TextAutoSizingKey& slot)
417 {
418     new (NotNull, &slot) TextAutoSizingKey(TextAutoSizingKey::Deleted);
419 }
420
421 bool TextAutoSizingTraits::isDeletedValue(const TextAutoSizingKey& value)
422 {
423     return value.isDeleted();
424 }
425
426 #endif
427
428 uint64_t Document::s_globalTreeVersion = 0;
429
430 HashSet<Document*>& Document::allDocuments()
431 {
432     static NeverDestroyed<HashSet<Document*>> documents;
433     return documents;
434 }
435
436 Document::Document(Frame* frame, const URL& url, unsigned documentClasses, unsigned constructionFlags)
437     : ContainerNode(*this, CreateDocument)
438     , TreeScope(*this)
439     , FrameDestructionObserver(frame)
440 #if ENABLE(IOS_TOUCH_EVENTS)
441     , m_touchEventsChangedTimer(*this, &Document::touchEventsChangedTimerFired)
442 #endif
443     , m_referencingNodeCount(0)
444     , m_settings(frame ? Ref<Settings>(frame->settings()) : Settings::create(nullptr))
445     , m_hasNodesWithPlaceholderStyle(false)
446     , m_needsNotifyRemoveAllPendingStylesheet(false)
447     , m_ignorePendingStylesheets(false)
448     , m_pendingSheetLayout(NoLayoutWithPendingSheets)
449     , m_cachedResourceLoader(m_frame ? Ref<CachedResourceLoader>(m_frame->loader().activeDocumentLoader()->cachedResourceLoader()) : CachedResourceLoader::create(nullptr))
450     , m_activeParserCount(0)
451     , m_wellFormed(false)
452     , m_printing(false)
453     , m_paginatedForScreen(false)
454     , m_compatibilityMode(DocumentCompatibilityMode::NoQuirksMode)
455     , m_compatibilityModeLocked(false)
456     , m_textColor(Color::black)
457     , m_domTreeVersion(++s_globalTreeVersion)
458     , m_listenerTypes(0)
459     , m_mutationObserverTypes(0)
460     , m_styleScope(std::make_unique<Style::Scope>(*this))
461     , m_extensionStyleSheets(std::make_unique<ExtensionStyleSheets>(*this))
462     , m_visitedLinkState(std::make_unique<VisitedLinkState>(*this))
463     , m_visuallyOrdered(false)
464     , m_readyState(Complete)
465     , m_bParsing(false)
466     , m_styleRecalcTimer(*this, &Document::updateStyleIfNeeded)
467     , m_pendingStyleRecalcShouldForce(false)
468     , m_inStyleRecalc(false)
469     , m_closeAfterStyleRecalc(false)
470     , m_gotoAnchorNeededAfterStylesheetsLoad(false)
471     , m_frameElementsShouldIgnoreScrolling(false)
472     , m_updateFocusAppearanceRestoresSelection(SelectionRestorationMode::SetDefault)
473     , m_markers(std::make_unique<DocumentMarkerController>(*this))
474     , m_updateFocusAppearanceTimer(*this, &Document::updateFocusAppearanceTimerFired)
475     , m_cssTarget(nullptr)
476     , m_processingLoadEvent(false)
477     , m_loadEventFinished(false)
478     , m_documentCreationTime(MonotonicTime::now())
479     , m_overMinimumLayoutThreshold(false)
480     , m_scriptRunner(std::make_unique<ScriptRunner>(*this))
481     , m_moduleLoader(std::make_unique<ScriptModuleLoader>(*this))
482     , m_xmlVersion(ASCIILiteral("1.0"))
483     , m_xmlStandalone(StandaloneUnspecified)
484     , m_hasXMLDeclaration(false)
485     , m_designMode(inherit)
486 #if ENABLE(DASHBOARD_SUPPORT)
487     , m_hasAnnotatedRegions(false)
488     , m_annotatedRegionsDirty(false)
489 #endif
490     , m_createRenderers(true)
491     , m_accessKeyMapValid(false)
492     , m_documentClasses(documentClasses)
493     , m_isSynthesized(constructionFlags & Synthesized)
494     , m_isNonRenderedPlaceholder(constructionFlags & NonRenderedPlaceholder)
495     , m_sawElementsInKnownNamespaces(false)
496     , m_isSrcdocDocument(false)
497     , m_eventQueue(*this)
498     , m_weakFactory(this)
499 #if ENABLE(FULLSCREEN_API)
500     , m_areKeysEnabledInFullScreen(0)
501     , m_fullScreenRenderer(nullptr)
502     , m_fullScreenChangeDelayTimer(*this, &Document::fullScreenChangeDelayTimerFired)
503     , m_isAnimatingFullScreen(false)
504 #endif
505     , m_loadEventDelayCount(0)
506     , m_loadEventDelayTimer(*this, &Document::loadEventDelayTimerFired)
507     , m_referrerPolicy(ReferrerPolicy::Default)
508     , m_writeRecursionIsTooDeep(false)
509     , m_writeRecursionDepth(0)
510     , m_lastHandledUserGestureTimestamp(0)
511 #if PLATFORM(IOS)
512 #if ENABLE(DEVICE_ORIENTATION)
513     , m_deviceMotionClient(std::make_unique<DeviceMotionClientIOS>())
514     , m_deviceMotionController(std::make_unique<DeviceMotionController>(m_deviceMotionClient.get()))
515     , m_deviceOrientationClient(std::make_unique<DeviceOrientationClientIOS>())
516     , m_deviceOrientationController(std::make_unique<DeviceOrientationController>(m_deviceOrientationClient.get()))
517 #endif
518 #endif
519 #if ENABLE(TELEPHONE_NUMBER_DETECTION)
520     , m_isTelephoneNumberParsingAllowed(true)
521 #endif
522     , m_pendingTasksTimer(*this, &Document::pendingTasksTimerFired)
523     , m_scheduledTasksAreSuspended(false)
524     , m_visualUpdatesAllowed(true)
525     , m_visualUpdatesSuppressionTimer(*this, &Document::visualUpdatesSuppressionTimerFired)
526     , m_sharedObjectPoolClearTimer(*this, &Document::clearSharedObjectPool)
527 #ifndef NDEBUG
528     , m_didDispatchViewportPropertiesChanged(false)
529 #endif
530     , m_templateDocumentHost(nullptr)
531     , m_fontSelector(CSSFontSelector::create(*this))
532 #if ENABLE(WEB_REPLAY)
533     , m_inputCursor(EmptyInputCursor::create())
534 #endif
535     , m_didAssociateFormControlsTimer(*this, &Document::didAssociateFormControlsTimerFired)
536     , m_cookieCacheExpiryTimer(*this, &Document::invalidateDOMCookieCache)
537     , m_disabledFieldsetElementsCount(0)
538     , m_hasInjectedPlugInsScript(false)
539     , m_hasStyleWithViewportUnits(false)
540 #if ENABLE(WEB_SOCKETS)
541     , m_socketProvider(page() ? &page()->socketProvider() : nullptr)
542 #endif
543 {
544     allDocuments().add(this);
545
546     // We depend on the url getting immediately set in subframes, but we
547     // also depend on the url NOT getting immediately set in opened windows.
548     // See fast/dom/early-frame-url.html
549     // and fast/dom/location-new-window-no-crash.html, respectively.
550     // FIXME: Can/should we unify this behavior?
551     if ((frame && frame->ownerElement()) || !url.isEmpty())
552         setURL(url);
553
554     m_cachedResourceLoader->setDocument(this);
555
556     resetLinkColor();
557     resetVisitedLinkColor();
558     resetActiveLinkColor();
559
560     initSecurityContext();
561     initDNSPrefetch();
562
563     m_fontSelector->registerForInvalidationCallbacks(*this);
564
565     for (auto& nodeListAndCollectionCount : m_nodeListAndCollectionCounts)
566         nodeListAndCollectionCount = 0;
567 }
568
569 #if ENABLE(FULLSCREEN_API)
570
571 static bool isAttributeOnAllOwners(const WebCore::QualifiedName& attribute, const WebCore::QualifiedName& prefixedAttribute, const HTMLFrameOwnerElement* owner)
572 {
573     if (!owner)
574         return true;
575     do {
576         if (!(owner->hasAttribute(attribute) || owner->hasAttribute(prefixedAttribute)))
577             return false;
578     } while ((owner = owner->document().ownerElement()));
579     return true;
580 }
581
582 #endif
583
584 Ref<Document> Document::create(Document& contextDocument)
585 {
586     auto document = adoptRef(*new Document(nullptr, URL()));
587     document->setContextDocument(contextDocument);
588     document->setSecurityOriginPolicy(contextDocument.securityOriginPolicy());
589     return document;
590 }
591
592 Document::~Document()
593 {
594     allDocuments().remove(this);
595
596     ASSERT(!renderView());
597     ASSERT(m_pageCacheState != InPageCache);
598     ASSERT(m_ranges.isEmpty());
599     ASSERT(!m_parentTreeScope);
600     ASSERT(!m_disabledFieldsetElementsCount);
601     ASSERT(m_inDocumentShadowRoots.isEmpty());
602
603 #if ENABLE(DEVICE_ORIENTATION) && PLATFORM(IOS)
604     m_deviceMotionClient->deviceMotionControllerDestroyed();
605     m_deviceOrientationClient->deviceOrientationControllerDestroyed();
606 #endif
607
608     if (m_templateDocument)
609         m_templateDocument->setTemplateDocumentHost(nullptr); // balanced in templateDocument().
610
611     // FIXME: Should we reset m_domWindow when we detach from the Frame?
612     if (m_domWindow)
613         m_domWindow->resetUnlessSuspendedForDocumentSuspension();
614
615     m_scriptRunner = nullptr;
616     m_moduleLoader = nullptr;
617
618     removeAllEventListeners();
619
620     // Currently we believe that Document can never outlive the parser.
621     // Although the Document may be replaced synchronously, DocumentParsers
622     // generally keep at least one reference to an Element which would in turn
623     // has a reference to the Document.  If you hit this ASSERT, then that
624     // assumption is wrong.  DocumentParser::detach() should ensure that even
625     // if the DocumentParser outlives the Document it won't cause badness.
626     ASSERT(!m_parser || m_parser->refCount() == 1);
627     detachParser();
628
629     if (this == &topDocument())
630         clearAXObjectCache();
631
632     m_decoder = nullptr;
633
634     if (m_styleSheetList)
635         m_styleSheetList->detachFromDocument();
636
637     extensionStyleSheets().detachFromDocument();
638
639     styleScope().clearResolver(); // We need to destroy CSSFontSelector before destroying m_cachedResourceLoader.
640     m_fontSelector->clearDocument();
641     m_fontSelector->unregisterForInvalidationCallbacks(*this);
642
643     // It's possible for multiple Documents to end up referencing the same CachedResourceLoader (e.g., SVGImages
644     // load the initial empty document and the SVGDocument with the same DocumentLoader).
645     if (m_cachedResourceLoader->document() == this)
646         m_cachedResourceLoader->setDocument(nullptr);
647
648 #if ENABLE(VIDEO)
649     if (auto* platformMediaSessionManager = PlatformMediaSessionManager::sharedManagerIfExists())
650         platformMediaSessionManager->stopAllMediaPlaybackForDocument(this);
651 #endif
652     
653     // We must call clearRareData() here since a Document class inherits TreeScope
654     // as well as Node. See a comment on TreeScope.h for the reason.
655     if (hasRareData())
656         clearRareData();
657
658     ASSERT(!m_listsInvalidatedAtDocument.size());
659     ASSERT(!m_collectionsInvalidatedAtDocument.size());
660
661     for (unsigned i = 0; i < WTF_ARRAY_LENGTH(m_nodeListAndCollectionCounts); ++i)
662         ASSERT(!m_nodeListAndCollectionCounts[i]);
663 }
664
665 void Document::removedLastRef()
666 {
667     ASSERT(!m_deletionHasBegun);
668     if (m_referencingNodeCount) {
669         // If removing a child removes the last node reference, we don't want the scope to be destroyed
670         // until after removeDetachedChildren returns, so we protect ourselves.
671         incrementReferencingNodeCount();
672
673         RELEASE_ASSERT(!hasLivingRenderTree());
674         // We must make sure not to be retaining any of our children through
675         // these extra pointers or we will create a reference cycle.
676         m_focusedElement = nullptr;
677         m_hoveredElement = nullptr;
678         m_activeElement = nullptr;
679         m_titleElement = nullptr;
680         m_documentElement = nullptr;
681         m_focusNavigationStartingNode = nullptr;
682         m_userActionElements.documentDidRemoveLastRef();
683 #if ENABLE(FULLSCREEN_API)
684         m_fullScreenElement = nullptr;
685         m_fullScreenElementStack.clear();
686 #endif
687
688         detachParser();
689
690         // removeDetachedChildren() doesn't always unregister IDs,
691         // so tear down scope information up front to avoid having
692         // stale references in the map.
693
694         destroyTreeScopeData();
695         removeDetachedChildren();
696         m_formController = nullptr;
697         
698         m_markers->detach();
699         
700         m_cssCanvasElements.clear();
701         
702         commonTeardown();
703
704 #ifndef NDEBUG
705         // We need to do this right now since selfOnlyDeref() can delete this.
706         m_inRemovedLastRefFunction = false;
707 #endif
708         decrementReferencingNodeCount();
709     } else {
710 #ifndef NDEBUG
711         m_inRemovedLastRefFunction = false;
712         m_deletionHasBegun = true;
713 #endif
714         delete this;
715     }
716 }
717
718 void Document::commonTeardown()
719 {
720     if (svgExtensions())
721         accessSVGExtensions().pauseAnimations();
722
723     clearScriptedAnimationController();
724 }
725
726 Element* Document::getElementByAccessKey(const String& key)
727 {
728     if (key.isEmpty())
729         return nullptr;
730     if (!m_accessKeyMapValid) {
731         buildAccessKeyMap(this);
732         m_accessKeyMapValid = true;
733     }
734     return m_elementsByAccessKey.get(key.impl());
735 }
736
737 void Document::buildAccessKeyMap(TreeScope* scope)
738 {
739     ASSERT(scope);
740     for (auto& element : descendantsOfType<Element>(scope->rootNode())) {
741         const AtomicString& accessKey = element.attributeWithoutSynchronization(accesskeyAttr);
742         if (!accessKey.isEmpty())
743             m_elementsByAccessKey.set(accessKey.impl(), &element);
744
745         if (ShadowRoot* root = element.shadowRoot())
746             buildAccessKeyMap(root);
747     }
748 }
749
750 void Document::invalidateAccessKeyMap()
751 {
752     m_accessKeyMapValid = false;
753     m_elementsByAccessKey.clear();
754 }
755
756 void Document::addImageElementByUsemap(const AtomicStringImpl& name, HTMLImageElement& element)
757 {
758     return m_imagesByUsemap.add(name, element, *this);
759 }
760
761 void Document::removeImageElementByUsemap(const AtomicStringImpl& name, HTMLImageElement& element)
762 {
763     return m_imagesByUsemap.remove(name, element);
764 }
765
766 HTMLImageElement* Document::imageElementByUsemap(const AtomicStringImpl& name) const
767 {
768     return m_imagesByUsemap.getElementByUsemap(name, *this);
769 }
770
771 ExceptionOr<SelectorQuery&> Document::selectorQueryForString(const String& selectorString)
772 {
773     if (selectorString.isEmpty())
774         return Exception { SYNTAX_ERR };
775     if (!m_selectorQueryCache)
776         m_selectorQueryCache = std::make_unique<SelectorQueryCache>();
777     return m_selectorQueryCache->add(selectorString, *this);
778 }
779
780 void Document::clearSelectorQueryCache()
781 {
782     m_selectorQueryCache = nullptr;
783 }
784
785 MediaQueryMatcher& Document::mediaQueryMatcher()
786 {
787     if (!m_mediaQueryMatcher)
788         m_mediaQueryMatcher = MediaQueryMatcher::create(*this);
789     return *m_mediaQueryMatcher;
790 }
791
792 void Document::setCompatibilityMode(DocumentCompatibilityMode mode)
793 {
794     if (m_compatibilityModeLocked || mode == m_compatibilityMode)
795         return;
796     bool wasInQuirksMode = inQuirksMode();
797     m_compatibilityMode = mode;
798
799     clearSelectorQueryCache();
800
801     if (inQuirksMode() != wasInQuirksMode) {
802         // All user stylesheets have to reparse using the different mode.
803         extensionStyleSheets().clearPageUserSheet();
804         extensionStyleSheets().invalidateInjectedStyleSheetCache();
805     }
806 }
807
808 String Document::compatMode() const
809 {
810     return inQuirksMode() ? "BackCompat" : "CSS1Compat";
811 }
812
813 void Document::resetLinkColor()
814 {
815     m_linkColor = Color(0, 0, 238);
816 }
817
818 void Document::resetVisitedLinkColor()
819 {
820     m_visitedLinkColor = Color(85, 26, 139);    
821 }
822
823 void Document::resetActiveLinkColor()
824 {
825     m_activeLinkColor = Color(255, 0, 0);
826 }
827
828 DOMImplementation& Document::implementation()
829 {
830     if (!m_implementation)
831         m_implementation = std::make_unique<DOMImplementation>(*this);
832     return *m_implementation;
833 }
834
835 bool Document::hasManifest() const
836 {
837     return documentElement() && documentElement()->hasTagName(htmlTag) && documentElement()->hasAttributeWithoutSynchronization(manifestAttr);
838 }
839
840 DocumentType* Document::doctype() const
841 {
842     for (Node* node = firstChild(); node; node = node->nextSibling()) {
843         if (node->isDocumentTypeNode())
844             return static_cast<DocumentType*>(node);
845     }
846     return nullptr;
847 }
848
849 void Document::childrenChanged(const ChildChange& change)
850 {
851     ContainerNode::childrenChanged(change);
852
853     // FIXME: Chrome::didReceiveDocType() used to be called only when the doctype changed. We need to check the
854     // impact of calling this systematically. If the overhead is negligible, we need to rename didReceiveDocType,
855     // otherwise, we need to detect the doc type changes before updating the viewport.
856     if (Page* page = this->page())
857         page->chrome().didReceiveDocType(*frame());
858
859     Element* newDocumentElement = childrenOfType<Element>(*this).first();
860     if (newDocumentElement == m_documentElement)
861         return;
862     m_documentElement = newDocumentElement;
863     // The root style used for media query matching depends on the document element.
864     styleScope().clearResolver();
865 }
866
867 static ALWAYS_INLINE Ref<HTMLElement> createUpgradeCandidateElement(Document& document, const QualifiedName& name)
868 {
869     if (!RuntimeEnabledFeatures::sharedFeatures().customElementsEnabled()
870         || Document::validateCustomElementName(name.localName()) != CustomElementNameValidationStatus::Valid)
871         return HTMLUnknownElement::create(name, document);
872
873     auto element = HTMLElement::create(name, document);
874     element->setIsCustomElementUpgradeCandidate();
875     return element;
876 }
877
878 static ALWAYS_INLINE Ref<HTMLElement> createUpgradeCandidateElement(Document& document, const AtomicString& localName)
879 {
880     return createUpgradeCandidateElement(document, QualifiedName { nullAtom, localName, xhtmlNamespaceURI });
881 }
882
883 static inline bool isValidHTMLElementName(const AtomicString& localName)
884 {
885     return Document::isValidName(localName);
886 }
887
888 static inline bool isValidHTMLElementName(const QualifiedName& name)
889 {
890     return Document::isValidName(name.localName());
891 }
892
893 template<typename NameType>
894 static ExceptionOr<Ref<Element>> createHTMLElementWithNameValidation(Document& document, const NameType& name)
895 {
896     auto element = HTMLElementFactory::createKnownElement(name, document);
897     if (LIKELY(element))
898         return Ref<Element> { element.releaseNonNull() };
899
900     if (auto* window = document.domWindow()) {
901         auto* registry = window->customElementRegistry();
902         if (UNLIKELY(registry)) {
903             if (auto* elementInterface = registry->findInterface(name))
904                 return elementInterface->constructElementWithFallback(document, name);
905         }
906     }
907
908     if (UNLIKELY(!isValidHTMLElementName(name)))
909         return Exception { INVALID_CHARACTER_ERR };
910
911     return Ref<Element> { createUpgradeCandidateElement(document, name) };
912 }
913
914 ExceptionOr<Ref<Element>> Document::createElementForBindings(const AtomicString& name)
915 {
916     if (isHTMLDocument())
917         return createHTMLElementWithNameValidation(*this, name.convertToASCIILowercase());
918
919     if (isXHTMLDocument())
920         return createHTMLElementWithNameValidation(*this, name);
921
922     if (!isValidName(name))
923         return Exception { INVALID_CHARACTER_ERR };
924
925     return createElement(QualifiedName(nullAtom, name, nullAtom), false);
926 }
927
928 Ref<DocumentFragment> Document::createDocumentFragment()
929 {
930     return DocumentFragment::create(document());
931 }
932
933 Ref<Text> Document::createTextNode(const String& data)
934 {
935     return Text::create(*this, data);
936 }
937
938 Ref<Comment> Document::createComment(const String& data)
939 {
940     return Comment::create(*this, data);
941 }
942
943 ExceptionOr<Ref<CDATASection>> Document::createCDATASection(const String& data)
944 {
945     if (isHTMLDocument())
946         return Exception { NOT_SUPPORTED_ERR };
947     return CDATASection::create(*this, data);
948 }
949
950 ExceptionOr<Ref<ProcessingInstruction>> Document::createProcessingInstruction(const String& target, const String& data)
951 {
952     if (!isValidName(target))
953         return Exception { INVALID_CHARACTER_ERR };
954
955     if (data.contains("?>"))
956         return Exception { INVALID_CHARACTER_ERR };
957
958     return ProcessingInstruction::create(*this, target, data);
959 }
960
961 Ref<Text> Document::createEditingTextNode(const String& text)
962 {
963     return Text::createEditingText(*this, text);
964 }
965
966 Ref<CSSStyleDeclaration> Document::createCSSStyleDeclaration()
967 {
968     Ref<MutableStyleProperties> propertySet(MutableStyleProperties::create());
969     return *propertySet->ensureCSSStyleDeclaration();
970 }
971
972 ExceptionOr<Ref<Node>> Document::importNode(Node& nodeToImport, bool deep)
973 {
974     switch (nodeToImport.nodeType()) {
975     case DOCUMENT_FRAGMENT_NODE:
976         if (nodeToImport.isShadowRoot())
977             break;
978         FALLTHROUGH;
979     case ELEMENT_NODE:
980     case TEXT_NODE:
981     case CDATA_SECTION_NODE:
982     case PROCESSING_INSTRUCTION_NODE:
983     case COMMENT_NODE:
984         return nodeToImport.cloneNodeInternal(document(), deep ? CloningOperation::Everything : CloningOperation::OnlySelf);
985
986     case ATTRIBUTE_NODE:
987         // FIXME: This will "Attr::normalize" child nodes of Attr.
988         return Ref<Node> { Attr::create(*this, QualifiedName(nullAtom, downcast<Attr>(nodeToImport).name(), nullAtom), downcast<Attr>(nodeToImport).value()) };
989
990     case DOCUMENT_NODE: // Can't import a document into another document.
991     case DOCUMENT_TYPE_NODE: // FIXME: Support cloning a DocumentType node per DOM4.
992         break;
993     }
994
995     return Exception { NOT_SUPPORTED_ERR };
996 }
997
998
999 ExceptionOr<Ref<Node>> Document::adoptNode(Node& source)
1000 {
1001     EventQueueScope scope;
1002
1003     switch (source.nodeType()) {
1004     case DOCUMENT_NODE:
1005         return Exception { NOT_SUPPORTED_ERR };
1006     case ATTRIBUTE_NODE: {
1007         auto& attr = downcast<Attr>(source);
1008         if (auto* element = attr.ownerElement()) {
1009             auto result = element->removeAttributeNode(attr);
1010             if (result.hasException())
1011                 return result.releaseException();
1012         }
1013         break;
1014     }       
1015     default:
1016         if (source.isShadowRoot()) {
1017             // ShadowRoot cannot disconnect itself from the host node.
1018             return Exception { HIERARCHY_REQUEST_ERR };
1019         }
1020         if (is<HTMLFrameOwnerElement>(source)) {
1021             auto& frameOwnerElement = downcast<HTMLFrameOwnerElement>(source);
1022             if (frame() && frame()->tree().isDescendantOf(frameOwnerElement.contentFrame()))
1023                 return Exception { HIERARCHY_REQUEST_ERR };
1024         }
1025         auto result = source.remove();
1026         if (result.hasException())
1027             return result.releaseException();
1028         ASSERT_WITH_SECURITY_IMPLICATION(!source.isConnected());
1029         ASSERT_WITH_SECURITY_IMPLICATION(!source.parentNode());
1030     }
1031
1032     adoptIfNeeded(source);
1033
1034     return Ref<Node> { source };
1035 }
1036
1037 bool Document::hasValidNamespaceForElements(const QualifiedName& qName)
1038 {
1039     // These checks are from DOM Core Level 2, createElementNS
1040     // http://www.w3.org/TR/DOM-Level-2-Core/core.html#ID-DocCrElNS
1041     if (!qName.prefix().isEmpty() && qName.namespaceURI().isNull()) // createElementNS(null, "html:div")
1042         return false;
1043     if (qName.prefix() == xmlAtom && qName.namespaceURI() != XMLNames::xmlNamespaceURI) // createElementNS("http://www.example.com", "xml:lang")
1044         return false;
1045
1046     // Required by DOM Level 3 Core and unspecified by DOM Level 2 Core:
1047     // http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407/core.html#ID-DocCrElNS
1048     // createElementNS("http://www.w3.org/2000/xmlns/", "foo:bar"), createElementNS(null, "xmlns:bar"), createElementNS(null, "xmlns")
1049     if (qName.prefix() == xmlnsAtom || (qName.prefix().isEmpty() && qName.localName() == xmlnsAtom))
1050         return qName.namespaceURI() == XMLNSNames::xmlnsNamespaceURI;
1051     return qName.namespaceURI() != XMLNSNames::xmlnsNamespaceURI;
1052 }
1053
1054 bool Document::hasValidNamespaceForAttributes(const QualifiedName& qName)
1055 {
1056     return hasValidNamespaceForElements(qName);
1057 }
1058
1059 static Ref<HTMLElement> createFallbackHTMLElement(Document& document, const QualifiedName& name)
1060 {
1061     if (auto* window = document.domWindow()) {
1062         auto* registry = window->customElementRegistry();
1063         if (UNLIKELY(registry)) {
1064             if (auto* elementInterface = registry->findInterface(name)) {
1065                 auto element = HTMLElement::create(name, document);
1066                 element->enqueueToUpgrade(*elementInterface);
1067                 return element;
1068             }
1069         }
1070     }
1071     // FIXME: Should we also check the equality of prefix between the custom element and name?
1072     return createUpgradeCandidateElement(document, name);
1073 }
1074
1075 // FIXME: This should really be in a possible ElementFactory class.
1076 Ref<Element> Document::createElement(const QualifiedName& name, bool createdByParser)
1077 {
1078     RefPtr<Element> element;
1079
1080     // FIXME: Use registered namespaces and look up in a hash to find the right factory.
1081     if (name.namespaceURI() == xhtmlNamespaceURI) {
1082         element = HTMLElementFactory::createKnownElement(name, *this, nullptr, createdByParser);
1083         if (UNLIKELY(!element))
1084             element = createFallbackHTMLElement(*this, name);
1085     } else if (name.namespaceURI() == SVGNames::svgNamespaceURI)
1086         element = SVGElementFactory::createElement(name, *this, createdByParser);
1087 #if ENABLE(MATHML)
1088     else if (name.namespaceURI() == MathMLNames::mathmlNamespaceURI)
1089         element = MathMLElementFactory::createElement(name, *this, createdByParser);
1090 #endif
1091
1092     if (element)
1093         m_sawElementsInKnownNamespaces = true;
1094     else
1095         element = Element::create(name, document());
1096
1097     // <image> uses imgTag so we need a special rule.
1098     ASSERT((name.matches(imageTag) && element->tagQName().matches(imgTag) && element->tagQName().prefix() == name.prefix()) || name == element->tagQName());
1099
1100     return element.releaseNonNull();
1101 }
1102
1103 CustomElementNameValidationStatus Document::validateCustomElementName(const AtomicString& localName)
1104 {
1105     bool containsHyphen = false;
1106     for (auto character : StringView(localName).codeUnits()) {
1107         if (isASCIIUpper(character))
1108             return CustomElementNameValidationStatus::ContainsUpperCase;
1109         if (character == '-')
1110             containsHyphen = true;
1111     }
1112
1113     if (!containsHyphen)
1114         return CustomElementNameValidationStatus::NoHyphen;
1115
1116 #if ENABLE(MATHML)
1117     const auto& annotationXmlLocalName = MathMLNames::annotation_xmlTag.localName();
1118 #else
1119     static NeverDestroyed<const AtomicString> annotationXmlLocalName("annotation-xml", AtomicString::ConstructFromLiteral);
1120 #endif
1121
1122     if (localName == SVGNames::color_profileTag.localName()
1123         || localName == SVGNames::font_faceTag.localName()
1124         || localName == SVGNames::font_face_formatTag.localName()
1125         || localName == SVGNames::font_face_nameTag.localName()
1126         || localName == SVGNames::font_face_srcTag.localName()
1127         || localName == SVGNames::font_face_uriTag.localName()
1128         || localName == SVGNames::missing_glyphTag.localName()
1129         || localName == annotationXmlLocalName)
1130         return CustomElementNameValidationStatus::ConflictsWithBuiltinNames;
1131
1132     return CustomElementNameValidationStatus::Valid;
1133 }
1134
1135 #if ENABLE(CSS_GRID_LAYOUT)
1136
1137 bool Document::isCSSGridLayoutEnabled() const
1138 {
1139     return RuntimeEnabledFeatures::sharedFeatures().isCSSGridLayoutEnabled();
1140 }
1141
1142 #endif
1143
1144 #if ENABLE(CSS_REGIONS)
1145
1146 RefPtr<DOMNamedFlowCollection> Document::webkitGetNamedFlows()
1147 {
1148     if (!renderView())
1149         return nullptr;
1150
1151     updateStyleIfNeeded();
1152
1153     return namedFlows().createCSSOMSnapshot();
1154 }
1155
1156 #endif
1157
1158 NamedFlowCollection& Document::namedFlows()
1159 {
1160     if (!m_namedFlows)
1161         m_namedFlows = NamedFlowCollection::create(this);
1162
1163     return *m_namedFlows;
1164 }
1165
1166 ExceptionOr<Ref<Element>> Document::createElementNS(const AtomicString& namespaceURI, const String& qualifiedName)
1167 {
1168     auto parseResult = parseQualifiedName(namespaceURI, qualifiedName);
1169     if (parseResult.hasException())
1170         return parseResult.releaseException();
1171     QualifiedName parsedName { parseResult.releaseReturnValue() };
1172     if (!hasValidNamespaceForElements(parsedName))
1173         return Exception { NAMESPACE_ERR };
1174
1175     if (parsedName.namespaceURI() == xhtmlNamespaceURI)
1176         return createHTMLElementWithNameValidation(*this, parsedName);
1177
1178     return createElement(parsedName, false);
1179 }
1180
1181 String Document::readyState() const
1182 {
1183     static NeverDestroyed<const String> loading(ASCIILiteral("loading"));
1184     static NeverDestroyed<const String> interactive(ASCIILiteral("interactive"));
1185     static NeverDestroyed<const String> complete(ASCIILiteral("complete"));
1186
1187     switch (m_readyState) {
1188     case Loading:
1189         return loading;
1190     case Interactive:
1191         return interactive;
1192     case Complete:
1193         return complete;
1194     }
1195
1196     ASSERT_NOT_REACHED();
1197     return String();
1198 }
1199
1200 void Document::setReadyState(ReadyState readyState)
1201 {
1202     if (readyState == m_readyState)
1203         return;
1204
1205 #if ENABLE(WEB_TIMING)
1206     switch (readyState) {
1207     case Loading:
1208         if (!m_documentTiming.domLoading)
1209             m_documentTiming.domLoading = MonotonicTime::now();
1210         break;
1211     case Interactive:
1212         if (!m_documentTiming.domInteractive)
1213             m_documentTiming.domInteractive = MonotonicTime::now();
1214         break;
1215     case Complete:
1216         if (!m_documentTiming.domComplete)
1217             m_documentTiming.domComplete = MonotonicTime::now();
1218         break;
1219     }
1220 #endif
1221
1222     m_readyState = readyState;
1223     dispatchEvent(Event::create(eventNames().readystatechangeEvent, false, false));
1224     
1225     if (settings().suppressesIncrementalRendering())
1226         setVisualUpdatesAllowed(readyState);
1227 }
1228
1229 void Document::setVisualUpdatesAllowed(ReadyState readyState)
1230 {
1231     ASSERT(settings().suppressesIncrementalRendering());
1232     switch (readyState) {
1233     case Loading:
1234         ASSERT(!m_visualUpdatesSuppressionTimer.isActive());
1235         ASSERT(m_visualUpdatesAllowed);
1236         setVisualUpdatesAllowed(false);
1237         break;
1238     case Interactive:
1239         ASSERT(m_visualUpdatesSuppressionTimer.isActive() || m_visualUpdatesAllowed);
1240         break;
1241     case Complete:
1242         if (m_visualUpdatesSuppressionTimer.isActive()) {
1243             ASSERT(!m_visualUpdatesAllowed);
1244
1245             if (!view()->visualUpdatesAllowedByClient())
1246                 return;
1247
1248             setVisualUpdatesAllowed(true);
1249         } else
1250             ASSERT(m_visualUpdatesAllowed);
1251         break;
1252     }
1253 }
1254     
1255 void Document::setVisualUpdatesAllowed(bool visualUpdatesAllowed)
1256 {
1257     if (m_visualUpdatesAllowed == visualUpdatesAllowed)
1258         return;
1259
1260     m_visualUpdatesAllowed = visualUpdatesAllowed;
1261
1262     if (visualUpdatesAllowed)
1263         m_visualUpdatesSuppressionTimer.stop();
1264     else
1265         m_visualUpdatesSuppressionTimer.startOneShot(settings().incrementalRenderingSuppressionTimeoutInSeconds());
1266
1267     if (!visualUpdatesAllowed)
1268         return;
1269
1270     FrameView* frameView = view();
1271     bool needsLayout = frameView && renderView() && (frameView->layoutPending() || renderView()->needsLayout());
1272     if (needsLayout)
1273         updateLayout();
1274
1275     if (Page* page = this->page()) {
1276         if (frame()->isMainFrame()) {
1277             frameView->addPaintPendingMilestones(DidFirstPaintAfterSuppressedIncrementalRendering);
1278             if (page->requestedLayoutMilestones() & DidFirstLayoutAfterSuppressedIncrementalRendering)
1279                 frame()->loader().didReachLayoutMilestone(DidFirstLayoutAfterSuppressedIncrementalRendering);
1280         }
1281     }
1282
1283     if (view())
1284         view()->updateCompositingLayersAfterLayout();
1285
1286     if (RenderView* renderView = this->renderView())
1287         renderView->repaintViewAndCompositedLayers();
1288
1289     if (Frame* frame = this->frame())
1290         frame->loader().forcePageTransitionIfNeeded();
1291 }
1292
1293 void Document::visualUpdatesSuppressionTimerFired()
1294 {
1295     ASSERT(!m_visualUpdatesAllowed);
1296
1297     // If the client is extending the visual update suppression period explicitly, the
1298     // watchdog should not re-enable visual updates itself, but should wait for the client.
1299     if (!view()->visualUpdatesAllowedByClient())
1300         return;
1301
1302     setVisualUpdatesAllowed(true);
1303 }
1304
1305 void Document::setVisualUpdatesAllowedByClient(bool visualUpdatesAllowedByClient)
1306 {
1307     // We should only re-enable visual updates if ReadyState is Completed or the watchdog timer has fired,
1308     // both of which we can determine by looking at the timer.
1309
1310     if (visualUpdatesAllowedByClient && !m_visualUpdatesSuppressionTimer.isActive() && !visualUpdatesAllowed())
1311         setVisualUpdatesAllowed(true);
1312 }
1313
1314 String Document::characterSetWithUTF8Fallback() const
1315 {
1316     AtomicString name = encoding();
1317     if (!name.isNull())
1318         return name;
1319     return UTF8Encoding().domName();
1320 }
1321
1322 String Document::defaultCharsetForLegacyBindings() const
1323 {
1324     if (!frame())
1325         UTF8Encoding().domName();
1326     return settings().defaultTextEncodingName();
1327 }
1328
1329 void Document::setCharset(const String& charset)
1330 {
1331     if (!decoder())
1332         return;
1333     decoder()->setEncoding(charset, TextResourceDecoder::UserChosenEncoding);
1334 }
1335
1336 void Document::setContentLanguage(const String& language)
1337 {
1338     if (m_contentLanguage == language)
1339         return;
1340     m_contentLanguage = language;
1341
1342     // Recalculate style so language is used when selecting the initial font.
1343     m_styleScope->didChangeStyleSheetEnvironment();
1344 }
1345
1346 ExceptionOr<void> Document::setXMLVersion(const String& version)
1347 {
1348     if (!XMLDocumentParser::supportsXMLVersion(version))
1349         return Exception { NOT_SUPPORTED_ERR };
1350
1351     m_xmlVersion = version;
1352     return { };
1353 }
1354
1355 void Document::setXMLStandalone(bool standalone)
1356 {
1357     m_xmlStandalone = standalone ? Standalone : NotStandalone;
1358 }
1359
1360 void Document::setDocumentURI(const String& uri)
1361 {
1362     // This property is read-only from JavaScript, but writable from Objective-C.
1363     m_documentURI = uri;
1364     updateBaseURL();
1365 }
1366
1367 void Document::setContent(const String& content)
1368 {
1369     open();
1370     // FIXME: This should probably use insert(), but that's (intentionally)
1371     // not implemented for the XML parser as it's normally synonymous with
1372     // document.write(). append() will end up yielding, but close() will
1373     // pump the tokenizer syncrhonously and finish the parse.
1374     m_parser->append(content.impl());
1375     close();
1376 }
1377
1378 String Document::suggestedMIMEType() const
1379 {
1380     if (isXHTMLDocument())
1381         return ASCIILiteral("application/xhtml+xml");
1382     if (isSVGDocument())
1383         return ASCIILiteral("image/svg+xml");
1384     if (xmlStandalone())
1385         return ASCIILiteral("text/xml");
1386     if (isHTMLDocument())
1387         return ASCIILiteral("text/html");
1388     if (DocumentLoader* loader = this->loader())
1389         return loader->responseMIMEType();
1390     return String();
1391 }
1392
1393 void Document::overrideMIMEType(const String& mimeType)
1394 {
1395     m_overriddenMIMEType = mimeType;
1396 }
1397
1398 String Document::contentType() const
1399 {
1400     if (!m_overriddenMIMEType.isNull())
1401         return m_overriddenMIMEType;
1402
1403     if (DocumentLoader* documentLoader = loader())
1404         return documentLoader->currentContentType();
1405
1406     String mimeType = suggestedMIMEType();
1407     if (!mimeType.isNull())
1408         return mimeType;
1409
1410     return ASCIILiteral("application/xml");
1411 }
1412
1413 RefPtr<Range> Document::caretRangeFromPoint(int x, int y)
1414 {
1415     return caretRangeFromPoint(LayoutPoint(x, y));
1416 }
1417
1418 RefPtr<Range> Document::caretRangeFromPoint(const LayoutPoint& clientPoint)
1419 {
1420     if (!hasLivingRenderTree())
1421         return nullptr;
1422
1423     LayoutPoint localPoint;
1424     Node* node = nodeFromPoint(clientPoint, &localPoint);
1425     if (!node)
1426         return nullptr;
1427
1428     RenderObject* renderer = node->renderer();
1429     if (!renderer)
1430         return nullptr;
1431     Position rangeCompliantPosition = renderer->positionForPoint(localPoint, nullptr).deepEquivalent().parentAnchoredEquivalent();
1432     if (rangeCompliantPosition.isNull())
1433         return nullptr;
1434
1435     unsigned offset = rangeCompliantPosition.offsetInContainerNode();
1436     node = &retargetToScope(*rangeCompliantPosition.containerNode());
1437     if (node != rangeCompliantPosition.containerNode())
1438         offset = 0;
1439
1440     return Range::create(*this, node, offset, node, offset);
1441 }
1442
1443 Element* Document::scrollingElement()
1444 {
1445     // FIXME: When we fix https://bugs.webkit.org/show_bug.cgi?id=106133, this should be replaced with the full implementation
1446     // of Document.scrollingElement() as specified at http://dev.w3.org/csswg/cssom-view/#dom-document-scrollingelement.
1447
1448     return body();
1449 }
1450
1451 template<typename CharacterType> static inline String canonicalizedTitle(Document& document, const String& title)
1452 {
1453     // FIXME: Compiling a separate copy of this for LChar and UChar is likely unnecessary.
1454     // FIXME: Missing an optimized case for when title is fine as-is. This unnecessarily allocates
1455     // and keeps around a new copy, and it's even the less optimal type of StringImpl with a separate buffer.
1456     // Could probably just use StringBuilder instead.
1457
1458     auto* characters = title.characters<CharacterType>();
1459     unsigned length = title.length();
1460
1461     StringBuffer<CharacterType> buffer { length };
1462     unsigned bufferLength = 0;
1463
1464     auto* decoder = document.decoder();
1465     auto backslashAsCurrencySymbol = decoder ? decoder->encoding().backslashAsCurrencySymbol() : '\\';
1466
1467     // Collapse runs of HTML spaces into single space characters.
1468     // Strip leading and trailing spaces.
1469     // Replace backslashes with currency symbols.
1470     bool previousCharacterWasHTMLSpace = false;
1471     for (unsigned i = 0; i < length; ++i) {
1472         auto character = characters[i];
1473         if (isHTMLSpace(character))
1474             previousCharacterWasHTMLSpace = true;
1475         else {
1476             if (character == '\\')
1477                 character = backslashAsCurrencySymbol;
1478             if (previousCharacterWasHTMLSpace && bufferLength)
1479                 buffer[bufferLength++] = ' ';
1480             buffer[bufferLength++] = character;
1481             previousCharacterWasHTMLSpace = false;
1482         }
1483     }
1484     if (!bufferLength)
1485         return { };
1486
1487     buffer.shrink(bufferLength);
1488     return String::adopt(WTFMove(buffer));
1489 }
1490
1491 void Document::updateTitle(const StringWithDirection& title)
1492 {
1493     if (m_rawTitle == title)
1494         return;
1495
1496     m_rawTitle = title;
1497     m_title = title;
1498
1499     if (!m_title.string.isEmpty()) {
1500         if (m_title.string.is8Bit())
1501             m_title.string = canonicalizedTitle<LChar>(*this, m_title.string);
1502         else
1503             m_title.string = canonicalizedTitle<UChar>(*this, m_title.string);
1504     }
1505
1506     if (auto* loader = this->loader())
1507         loader->setTitle(m_title);
1508 }
1509
1510 void Document::updateTitleFromTitleElement()
1511 {
1512     if (!m_titleElement) {
1513         updateTitle({ });
1514         return;
1515     }
1516
1517     if (is<HTMLTitleElement>(*m_titleElement))
1518         updateTitle(downcast<HTMLTitleElement>(*m_titleElement).textWithDirection());
1519     else if (is<SVGTitleElement>(*m_titleElement)) {
1520         // FIXME: Does the SVG title element have a text direction?
1521         updateTitle({ downcast<SVGTitleElement>(*m_titleElement).textContent(), LTR });
1522     }
1523 }
1524
1525 void Document::setTitle(const String& title)
1526 {
1527     if (!m_titleElement) {
1528         if (isHTMLDocument() || isXHTMLDocument()) {
1529             auto* headElement = head();
1530             if (!headElement)
1531                 return;
1532             m_titleElement = HTMLTitleElement::create(HTMLNames::titleTag, *this);
1533             headElement->appendChild(*m_titleElement);
1534         } else if (isSVGDocument()) {
1535             auto* element = documentElement();
1536             if (!is<SVGSVGElement>(element))
1537                 return;
1538             m_titleElement = SVGTitleElement::create(SVGNames::titleTag, *this);
1539             element->insertBefore(*m_titleElement, element->firstChild());
1540         }
1541     } else if (!isHTMLDocument() && !isXHTMLDocument() && !isSVGDocument()) {
1542         // FIXME: What exactly is the point of this? This seems like a strange moment
1543         // in time to demote something from being m_titleElement, when setting the
1544         // value of the title attribute. Do we have test coverage for this?
1545         m_titleElement = nullptr;
1546     }
1547
1548     if (is<HTMLTitleElement>(m_titleElement.get()))
1549         downcast<HTMLTitleElement>(*m_titleElement).setTextContent(title);
1550     else if (is<SVGTitleElement>(m_titleElement.get()))
1551         downcast<SVGTitleElement>(*m_titleElement).setTextContent(title);
1552     else
1553         updateTitle({ title, LTR });
1554 }
1555
1556 void Document::updateTitleElement(Element* newTitleElement)
1557 {
1558     if (is<SVGSVGElement>(documentElement()))
1559         m_titleElement = childrenOfType<SVGTitleElement>(*documentElement()).first();
1560     else {
1561         if (m_titleElement) {
1562             if (isHTMLDocument() || isXHTMLDocument())
1563                 m_titleElement = descendantsOfType<HTMLTitleElement>(*this).first();
1564         } else
1565             m_titleElement = newTitleElement;
1566     }
1567
1568     updateTitleFromTitleElement();
1569 }
1570
1571 void Document::titleElementAdded(Element& titleElement)
1572 {
1573     if (m_titleElement == &titleElement)
1574         return;
1575
1576     updateTitleElement(&titleElement);
1577 }
1578
1579 void Document::titleElementRemoved(Element& titleElement)
1580 {
1581     if (m_titleElement != &titleElement)
1582         return;
1583
1584     updateTitleElement(nullptr);
1585 }
1586
1587 void Document::titleElementTextChanged(Element& titleElement)
1588 {
1589     if (m_titleElement != &titleElement)
1590         return;
1591
1592     updateTitleFromTitleElement();
1593 }
1594
1595 void Document::registerForVisibilityStateChangedCallbacks(Element* element)
1596 {
1597     m_visibilityStateCallbackElements.add(element);
1598 }
1599
1600 void Document::unregisterForVisibilityStateChangedCallbacks(Element* element)
1601 {
1602     m_visibilityStateCallbackElements.remove(element);
1603 }
1604
1605 void Document::visibilityStateChanged()
1606 {
1607     dispatchEvent(Event::create(eventNames().visibilitychangeEvent, false, false));
1608     for (auto* element : m_visibilityStateCallbackElements)
1609         element->visibilityStateChanged();
1610 }
1611
1612 auto Document::visibilityState() const -> VisibilityState
1613 {
1614     // The visibility of the document is inherited from the visibility of the
1615     // page. If there is no page associated with the document, we will assume
1616     // that the page is hidden, as specified by the spec:
1617     // http://dvcs.w3.org/hg/webperf/raw-file/tip/specs/PageVisibility/Overview.html#dom-document-hidden
1618     if (!m_frame || !m_frame->page())
1619         return VisibilityState::Hidden;
1620     return m_frame->page()->visibilityState();
1621 }
1622
1623 bool Document::hidden() const
1624 {
1625     return visibilityState() != VisibilityState::Visible;
1626 }
1627
1628 #if ENABLE(VIDEO)
1629
1630 void Document::registerForAllowsMediaDocumentInlinePlaybackChangedCallbacks(HTMLMediaElement& element)
1631 {
1632     m_allowsMediaDocumentInlinePlaybackElements.add(&element);
1633 }
1634
1635 void Document::unregisterForAllowsMediaDocumentInlinePlaybackChangedCallbacks(HTMLMediaElement& element)
1636 {
1637     m_allowsMediaDocumentInlinePlaybackElements.remove(&element);
1638 }
1639
1640 void Document::allowsMediaDocumentInlinePlaybackChanged()
1641 {
1642     for (auto* element : m_allowsMediaDocumentInlinePlaybackElements)
1643         element->allowsMediaDocumentInlinePlaybackChanged();
1644 }
1645
1646 #endif
1647
1648 String Document::nodeName() const
1649 {
1650     return ASCIILiteral("#document");
1651 }
1652
1653 Node::NodeType Document::nodeType() const
1654 {
1655     return DOCUMENT_NODE;
1656 }
1657
1658 FormController& Document::formController()
1659 {
1660     if (!m_formController)
1661         m_formController = std::make_unique<FormController>();
1662     return *m_formController;
1663 }
1664
1665 Vector<String> Document::formElementsState() const
1666 {
1667     if (!m_formController)
1668         return Vector<String>();
1669     return m_formController->formElementsState();
1670 }
1671
1672 void Document::setStateForNewFormElements(const Vector<String>& stateVector)
1673 {
1674     if (!stateVector.size() && !m_formController)
1675         return;
1676     formController().setStateForNewFormElements(stateVector);
1677 }
1678
1679 FrameView* Document::view() const
1680 {
1681     return m_frame ? m_frame->view() : nullptr;
1682 }
1683
1684 Page* Document::page() const
1685 {
1686     return m_frame ? m_frame->page() : nullptr;
1687 }
1688
1689 Ref<Range> Document::createRange()
1690 {
1691     return Range::create(*this);
1692 }
1693
1694 Ref<NodeIterator> Document::createNodeIterator(Node& root, unsigned long whatToShow, RefPtr<NodeFilter>&& filter, bool)
1695 {
1696     return NodeIterator::create(root, whatToShow, WTFMove(filter));
1697 }
1698
1699 Ref<TreeWalker> Document::createTreeWalker(Node& root, unsigned long whatToShow, RefPtr<NodeFilter>&& filter, bool)
1700 {
1701     return TreeWalker::create(root, whatToShow, WTFMove(filter));
1702 }
1703
1704 void Document::scheduleForcedStyleRecalc()
1705 {
1706     m_pendingStyleRecalcShouldForce = true;
1707     scheduleStyleRecalc();
1708 }
1709
1710 void Document::scheduleStyleRecalc()
1711 {
1712     ASSERT(!m_renderView || !m_renderView->inHitTesting());
1713
1714     if (m_styleRecalcTimer.isActive() || pageCacheState() != NotInPageCache)
1715         return;
1716
1717     ASSERT(childNeedsStyleRecalc() || m_pendingStyleRecalcShouldForce);
1718
1719     // FIXME: Why on earth is this here? This is clearly misplaced.
1720     invalidateAccessKeyMap();
1721     
1722     m_styleRecalcTimer.startOneShot(0);
1723
1724     InspectorInstrumentation::didScheduleStyleRecalculation(*this);
1725 }
1726
1727 void Document::unscheduleStyleRecalc()
1728 {
1729     ASSERT(!childNeedsStyleRecalc());
1730
1731     m_styleRecalcTimer.stop();
1732     m_pendingStyleRecalcShouldForce = false;
1733 }
1734
1735 bool Document::hasPendingStyleRecalc() const
1736 {
1737     return m_styleRecalcTimer.isActive() && !m_inStyleRecalc;
1738 }
1739
1740 bool Document::hasPendingForcedStyleRecalc() const
1741 {
1742     return m_styleRecalcTimer.isActive() && m_pendingStyleRecalcShouldForce;
1743 }
1744
1745 void Document::recalcStyle(Style::Change change)
1746 {
1747     ASSERT(!view() || !view()->isPainting());
1748
1749     // NOTE: XSL code seems to be the only client stumbling in here without a RenderView.
1750     if (!m_renderView)
1751         return;
1752
1753     FrameView& frameView = m_renderView->frameView();
1754     Ref<FrameView> protect(frameView);
1755     if (frameView.isPainting())
1756         return;
1757     
1758     if (m_inStyleRecalc)
1759         return; // Guard against re-entrancy. -dwh
1760
1761     TraceScope tracingScope(StyleRecalcStart, StyleRecalcEnd);
1762
1763     RenderView::RepaintRegionAccumulator repaintRegionAccumulator(renderView());
1764     AnimationUpdateBlock animationUpdateBlock(&m_frame->animation());
1765
1766     // FIXME: We should update style on our ancestor chain before proceeding (especially for seamless),
1767     // however doing so currently causes several tests to crash, as Frame::setDocument calls Document::attach
1768     // before setting the DOMWindow on the Frame, or the SecurityOrigin on the document. The attach, in turn
1769     // resolves style (here) and then when we resolve style on the parent chain, we may end up
1770     // re-attaching our containing iframe, which when asked HTMLFrameElementBase::isURLAllowed
1771     // hits a null-dereference due to security code always assuming the document has a SecurityOrigin.
1772
1773     styleScope().flushPendingUpdate();
1774
1775     frameView.willRecalcStyle();
1776
1777     InspectorInstrumentationCookie cookie = InspectorInstrumentation::willRecalculateStyle(*this);
1778
1779     m_inStyleRecalc = true;
1780     bool updatedCompositingLayers = false;
1781     {
1782         Style::PostResolutionCallbackDisabler disabler(*this);
1783         WidgetHierarchyUpdatesSuspensionScope suspendWidgetHierarchyUpdates;
1784
1785         if (m_pendingStyleRecalcShouldForce)
1786             change = Style::Force;
1787
1788         if (change == Style::Force) {
1789             // This may get set again during style resolve.
1790             m_hasNodesWithPlaceholderStyle = false;
1791
1792             auto documentStyle = Style::resolveForDocument(*this);
1793
1794             // Inserting the pictograph font at the end of the font fallback list is done by the
1795             // font selector, so set a font selector if needed.
1796             if (settings().fontFallbackPrefersPictographs())
1797                 documentStyle.fontCascade().update(&fontSelector());
1798
1799             auto documentChange = Style::determineChange(documentStyle, m_renderView->style());
1800             if (documentChange != Style::NoChange)
1801                 renderView()->setStyle(WTFMove(documentStyle));
1802         }
1803
1804         Style::TreeResolver resolver(*this);
1805         auto styleUpdate = resolver.resolve(change);
1806
1807         m_lastStyleUpdateSizeForTesting = styleUpdate ? styleUpdate->size() : 0;
1808
1809         setHasValidStyle();
1810         clearChildNeedsStyleRecalc();
1811         unscheduleStyleRecalc();
1812
1813         m_inStyleRecalc = false;
1814
1815         if (styleUpdate) {
1816             SetForScope<bool> inRenderTreeUpdate(m_inRenderTreeUpdate, true);
1817
1818             RenderTreeUpdater updater(*this);
1819             updater.commit(WTFMove(styleUpdate));
1820         }
1821
1822         updatedCompositingLayers = frameView.updateCompositingLayersAfterStyleChange();
1823     }
1824
1825     // If we wanted to call implicitClose() during recalcStyle, do so now that we're finished.
1826     if (m_closeAfterStyleRecalc) {
1827         m_closeAfterStyleRecalc = false;
1828         implicitClose();
1829     }
1830     
1831     ++m_styleRecalcCount;
1832
1833     InspectorInstrumentation::didRecalculateStyle(cookie);
1834
1835     // Some animated images may now be inside the viewport due to style recalc,
1836     // resume them if necessary if there is no layout pending. Otherwise, we'll
1837     // check if they need to be resumed after layout.
1838     if (updatedCompositingLayers && !frameView.needsLayout())
1839         frameView.viewportContentsChanged();
1840
1841     if (!frameView.needsLayout())
1842         frameView.frame().selection().updateAppearanceAfterLayout();
1843
1844     // As a result of the style recalculation, the currently hovered element might have been
1845     // detached (for example, by setting display:none in the :hover style), schedule another mouseMove event
1846     // to check if any other elements ended up under the mouse pointer due to re-layout.
1847     if (m_hoveredElement && !m_hoveredElement->renderer())
1848         frameView.frame().mainFrame().eventHandler().dispatchFakeMouseMoveEventSoon();
1849 }
1850
1851 bool Document::needsStyleRecalc() const
1852 {
1853     if (pageCacheState() != NotInPageCache)
1854         return false;
1855
1856     return m_pendingStyleRecalcShouldForce || childNeedsStyleRecalc() || styleScope().hasPendingUpdate();
1857 }
1858
1859 void Document::updateStyleIfNeeded()
1860 {
1861     ASSERT(isMainThread());
1862     ASSERT(!view() || !view()->isPainting());
1863
1864     if (!view() || view()->isInRenderTreeLayout())
1865         return;
1866
1867     styleScope().flushPendingUpdate();
1868
1869     if (!needsStyleRecalc())
1870         return;
1871
1872     recalcStyle();
1873 }
1874
1875 void Document::updateLayout()
1876 {
1877     ASSERT(isMainThread());
1878
1879     FrameView* frameView = view();
1880     if (frameView && frameView->isInRenderTreeLayout()) {
1881         // View layout should not be re-entrant.
1882         ASSERT_NOT_REACHED();
1883         return;
1884     }
1885
1886     RenderView::RepaintRegionAccumulator repaintRegionAccumulator(renderView());
1887
1888     if (HTMLFrameOwnerElement* owner = ownerElement())
1889         owner->document().updateLayout();
1890
1891     updateStyleIfNeeded();
1892
1893     StackStats::LayoutCheckPoint layoutCheckPoint;
1894
1895     // Only do a layout if changes have occurred that make it necessary.      
1896     if (frameView && renderView() && (frameView->layoutPending() || renderView()->needsLayout()))
1897         frameView->layout();
1898 }
1899
1900 // FIXME: This is a bad idea and needs to be removed eventually.
1901 // Other browsers load stylesheets before they continue parsing the web page.
1902 // Since we don't, we can run JavaScript code that needs answers before the
1903 // stylesheets are loaded. Doing a layout ignoring the pending stylesheets
1904 // lets us get reasonable answers. The long term solution to this problem is
1905 // to instead suspend JavaScript execution.
1906 void Document::updateLayoutIgnorePendingStylesheets(Document::RunPostLayoutTasks runPostLayoutTasks)
1907 {
1908     bool oldIgnore = m_ignorePendingStylesheets;
1909
1910     if (!haveStylesheetsLoaded()) {
1911         m_ignorePendingStylesheets = true;
1912         // FIXME: We are willing to attempt to suppress painting with outdated style info only once.  Our assumption is that it would be
1913         // dangerous to try to stop it a second time, after page content has already been loaded and displayed
1914         // with accurate style information.  (Our suppression involves blanking the whole page at the
1915         // moment.  If it were more refined, we might be able to do something better.)
1916         // It's worth noting though that this entire method is a hack, since what we really want to do is
1917         // suspend JS instead of doing a layout with inaccurate information.
1918         HTMLElement* bodyElement = bodyOrFrameset();
1919         if (bodyElement && !bodyElement->renderer() && m_pendingSheetLayout == NoLayoutWithPendingSheets) {
1920             m_pendingSheetLayout = DidLayoutWithPendingSheets;
1921             styleScope().didChangeActiveStyleSheetCandidates();
1922             recalcStyle(Style::Force);
1923         } else if (m_hasNodesWithPlaceholderStyle)
1924             // If new nodes have been added or style recalc has been done with style sheets still pending, some nodes 
1925             // may not have had their real style calculated yet. Normally this gets cleaned when style sheets arrive 
1926             // but here we need up-to-date style immediately.
1927             recalcStyle(Style::Force);
1928     }
1929
1930     updateLayout();
1931
1932     if (runPostLayoutTasks == RunPostLayoutTasks::Synchronously && view())
1933         view()->flushAnyPendingPostLayoutTasks();
1934
1935     m_ignorePendingStylesheets = oldIgnore;
1936 }
1937
1938 std::unique_ptr<RenderStyle> Document::styleForElementIgnoringPendingStylesheets(Element& element, const RenderStyle* parentStyle)
1939 {
1940     ASSERT(&element.document() == this);
1941
1942     // On iOS request delegates called during styleForElement may result in re-entering WebKit and killing the style resolver.
1943     Style::PostResolutionCallbackDisabler disabler(*this);
1944
1945     SetForScope<bool> change(m_ignorePendingStylesheets, true);
1946     auto elementStyle = element.resolveStyle(parentStyle);
1947
1948     if (elementStyle.relations) {
1949         Style::Update emptyUpdate(*this);
1950         Style::commitRelations(WTFMove(elementStyle.relations), emptyUpdate);
1951     }
1952
1953     return WTFMove(elementStyle.renderStyle);
1954 }
1955
1956 bool Document::updateLayoutIfDimensionsOutOfDate(Element& element, DimensionsCheck dimensionsCheck)
1957 {
1958     ASSERT(isMainThread());
1959     
1960     // If the stylesheets haven't loaded, just give up and do a full layout ignoring pending stylesheets.
1961     if (!haveStylesheetsLoaded()) {
1962         updateLayoutIgnorePendingStylesheets();
1963         return true;
1964     }
1965     
1966     // Check for re-entrancy and assert (same code that is in updateLayout()).
1967     FrameView* frameView = view();
1968     if (frameView && frameView->isInRenderTreeLayout()) {
1969         // View layout should not be re-entrant.
1970         ASSERT_NOT_REACHED();
1971         return true;
1972     }
1973     
1974     RenderView::RepaintRegionAccumulator repaintRegionAccumulator(renderView());
1975     
1976     // Mimic the structure of updateLayout(), but at each step, see if we have been forced into doing a full
1977     // layout.
1978     bool requireFullLayout = false;
1979     if (HTMLFrameOwnerElement* owner = ownerElement()) {
1980         if (owner->document().updateLayoutIfDimensionsOutOfDate(*owner))
1981             requireFullLayout = true;
1982     }
1983     
1984     updateStyleIfNeeded();
1985
1986     RenderObject* renderer = element.renderer();
1987     if (!renderer || renderer->needsLayout() || element.renderNamedFlowFragment()) {
1988         // If we don't have a renderer or if the renderer needs layout for any reason, give up.
1989         // Named flows can have auto height, so don't try to enforce the optimization in this case.
1990         // The 2-pass nature of auto height named flow layout means the region may not be dirty yet.
1991         requireFullLayout = true;
1992     }
1993
1994     bool isVertical = renderer && !renderer->isHorizontalWritingMode();
1995     bool checkingLogicalWidth = ((dimensionsCheck & WidthDimensionsCheck) && !isVertical) || ((dimensionsCheck & HeightDimensionsCheck) && isVertical);
1996     bool checkingLogicalHeight = ((dimensionsCheck & HeightDimensionsCheck) && !isVertical) || ((dimensionsCheck & WidthDimensionsCheck) && isVertical);
1997     bool hasSpecifiedLogicalHeight = renderer && renderer->style().logicalMinHeight() == Length(0, Fixed) && renderer->style().logicalHeight().isFixed() && renderer->style().logicalMaxHeight().isAuto();
1998     
1999     if (!requireFullLayout) {
2000         RenderBox* previousBox = nullptr;
2001         RenderBox* currentBox = nullptr;
2002         
2003         // Check our containing block chain. If anything in the chain needs a layout, then require a full layout.
2004         for (RenderObject* currRenderer = element.renderer(); currRenderer && !currRenderer->isRenderView(); currRenderer = currRenderer->container()) {
2005             
2006             // Require the entire container chain to be boxes.
2007             if (!is<RenderBox>(currRenderer)) {
2008                 requireFullLayout = true;
2009                 break;
2010             }
2011             
2012             previousBox = currentBox;
2013             currentBox = downcast<RenderBox>(currRenderer);
2014             
2015             // If a box needs layout for itself or if a box has changed children and sizes its width to
2016             // its content, then require a full layout.
2017             if (currentBox->selfNeedsLayout() ||
2018                 (checkingLogicalWidth && currRenderer->needsLayout() && currentBox->sizesLogicalWidthToFitContent(MainOrPreferredSize))) {
2019                 requireFullLayout = true;
2020                 break;
2021             }
2022             
2023             // If a block contains floats and the child's height isn't specified, then
2024             // give up also, since our height could end up being influenced by the floats.
2025             if (checkingLogicalHeight && !hasSpecifiedLogicalHeight && currentBox->isRenderBlockFlow()) {
2026                 RenderBlockFlow* currentBlockFlow = downcast<RenderBlockFlow>(currentBox);
2027                 if (currentBlockFlow->containsFloats() && previousBox && !previousBox->isFloatingOrOutOfFlowPositioned()) {
2028                     requireFullLayout = true;
2029                     break;
2030                 }
2031             }
2032             
2033             if (!currentBox->isRenderBlockFlow() || currentBox->flowThreadContainingBlock() || currentBox->isWritingModeRoot()) {
2034                 // FIXME: For now require only block flows all the way back to the root. This limits the optimization
2035                 // for now, and we'll expand it in future patches to apply to more and more scenarios.
2036                 // Disallow regions/columns from having the optimization.
2037                 // Give up if the writing mode changes at all in the containing block chain.
2038                 requireFullLayout = true;
2039                 break;
2040             }
2041             
2042             if (currRenderer == frameView->layoutRoot())
2043                 break;
2044         }
2045     }
2046     
2047     StackStats::LayoutCheckPoint layoutCheckPoint;
2048
2049     // Only do a layout if changes have occurred that make it necessary.      
2050     if (requireFullLayout && frameView && renderView() && (frameView->layoutPending() || renderView()->needsLayout()))
2051         frameView->layout();
2052     
2053     return requireFullLayout;
2054 }
2055
2056 bool Document::isPageBoxVisible(int pageIndex)
2057 {
2058     updateStyleIfNeeded();
2059     std::unique_ptr<RenderStyle> pageStyle(styleScope().resolver().styleForPage(pageIndex));
2060     return pageStyle->visibility() != HIDDEN; // display property doesn't apply to @page.
2061 }
2062
2063 void Document::pageSizeAndMarginsInPixels(int pageIndex, IntSize& pageSize, int& marginTop, int& marginRight, int& marginBottom, int& marginLeft)
2064 {
2065     updateStyleIfNeeded();
2066     auto style = styleScope().resolver().styleForPage(pageIndex);
2067
2068     int width = pageSize.width();
2069     int height = pageSize.height();
2070     switch (style->pageSizeType()) {
2071     case PAGE_SIZE_AUTO:
2072         break;
2073     case PAGE_SIZE_AUTO_LANDSCAPE:
2074         if (width < height)
2075             std::swap(width, height);
2076         break;
2077     case PAGE_SIZE_AUTO_PORTRAIT:
2078         if (width > height)
2079             std::swap(width, height);
2080         break;
2081     case PAGE_SIZE_RESOLVED: {
2082         auto& size = style->pageSize();
2083         ASSERT(size.width.isFixed());
2084         ASSERT(size.height.isFixed());
2085         width = valueForLength(size.width, 0);
2086         height = valueForLength(size.height, 0);
2087         break;
2088     }
2089     default:
2090         ASSERT_NOT_REACHED();
2091     }
2092     pageSize = IntSize(width, height);
2093
2094     // The percentage is calculated with respect to the width even for margin top and bottom.
2095     // http://www.w3.org/TR/CSS2/box.html#margin-properties
2096     marginTop = style->marginTop().isAuto() ? marginTop : intValueForLength(style->marginTop(), width);
2097     marginRight = style->marginRight().isAuto() ? marginRight : intValueForLength(style->marginRight(), width);
2098     marginBottom = style->marginBottom().isAuto() ? marginBottom : intValueForLength(style->marginBottom(), width);
2099     marginLeft = style->marginLeft().isAuto() ? marginLeft : intValueForLength(style->marginLeft(), width);
2100 }
2101
2102 StyleResolver& Document::userAgentShadowTreeStyleResolver()
2103 {
2104     if (!m_userAgentShadowTreeStyleResolver)
2105         m_userAgentShadowTreeStyleResolver = std::make_unique<StyleResolver>(*this);
2106     return *m_userAgentShadowTreeStyleResolver;
2107 }
2108
2109 void Document::fontsNeedUpdate(FontSelector&)
2110 {
2111     if (auto* resolver = styleScope().resolverIfExists())
2112         resolver->invalidateMatchedPropertiesCache();
2113     if (pageCacheState() != NotInPageCache || !renderView())
2114         return;
2115     scheduleForcedStyleRecalc();
2116 }
2117
2118 void Document::didClearStyleResolver()
2119 {
2120     m_userAgentShadowTreeStyleResolver = nullptr;
2121
2122     m_fontSelector->buildStarted();
2123 }
2124
2125 void Document::createRenderTree()
2126 {
2127     ASSERT(!renderView());
2128     ASSERT(m_pageCacheState != InPageCache);
2129     ASSERT(!m_axObjectCache || this != &topDocument());
2130
2131     if (m_isNonRenderedPlaceholder)
2132         return;
2133
2134     // FIXME: It would be better if we could pass the resolved document style directly here.
2135     m_renderView = createRenderer<RenderView>(*this, RenderStyle::create());
2136     Node::setRenderer(m_renderView.get());
2137
2138     renderView()->setIsInWindow(true);
2139
2140     recalcStyle(Style::Force);
2141 }
2142
2143 void Document::didBecomeCurrentDocumentInFrame()
2144 {
2145     // FIXME: Are there cases where the document can be dislodged from the frame during the event handling below?
2146     // If so, then m_frame could become 0, and we need to do something about that.
2147
2148     m_frame->script().updateDocument();
2149
2150     if (!hasLivingRenderTree())
2151         createRenderTree();
2152
2153     updateViewportArguments();
2154
2155     // FIXME: Doing this only for the main frame is insufficient.
2156     // Changing a subframe can also change the wheel event handler count.
2157     // FIXME: Doing this only when a document goes into the frame is insufficient.
2158     // Removing a document can also change the wheel event handler count.
2159     // FIXME: Doing this every time is a waste. If the current document and its
2160     // subframes' documents have no wheel event handlers, then the count did not change,
2161     // unless the documents they are replacing had wheel event handlers.
2162     if (page() && m_frame->isMainFrame())
2163         wheelEventHandlersChanged();
2164
2165     // Ensure that the scheduled task state of the document matches the DOM suspension state of the frame. It can
2166     // be out of sync if the DOM suspension state changed while the document was not in the frame (possibly in the
2167     // page cache, or simply newly created).
2168     if (m_frame->activeDOMObjectsAndAnimationsSuspended()) {
2169         m_frame->animation().suspendAnimationsForDocument(this);
2170         suspendScheduledTasks(ActiveDOMObject::PageWillBeSuspended);
2171     } else {
2172         resumeScheduledTasks(ActiveDOMObject::PageWillBeSuspended);
2173         m_frame->animation().resumeAnimationsForDocument(this);
2174     }
2175 }
2176
2177 void Document::frameDestroyed()
2178 {
2179     // detachFromFrame() must be called before destroying the Frame.
2180     ASSERT_WITH_SECURITY_IMPLICATION(!m_frame);
2181     FrameDestructionObserver::frameDestroyed();
2182 }
2183
2184 void Document::attachToCachedFrame(CachedFrameBase& cachedFrame)
2185 {
2186     ASSERT_WITH_SECURITY_IMPLICATION(cachedFrame.document() == this);
2187     ASSERT(cachedFrame.view());
2188     ASSERT(m_pageCacheState == Document::InPageCache);
2189     observeFrame(&cachedFrame.view()->frame());
2190 }
2191
2192 void Document::detachFromCachedFrame(CachedFrameBase& cachedFrame)
2193 {
2194     ASSERT_UNUSED(cachedFrame, cachedFrame.view());
2195     ASSERT_WITH_SECURITY_IMPLICATION(cachedFrame.document() == this);
2196     ASSERT(m_frame == &cachedFrame.view()->frame());
2197     ASSERT(m_pageCacheState == Document::InPageCache);
2198     detachFromFrame();
2199 }
2200
2201 void Document::destroyRenderTree()
2202 {
2203     ASSERT(hasLivingRenderTree());
2204     ASSERT(frame());
2205     ASSERT(frame()->view());
2206     ASSERT(page());
2207
2208     FrameView* frameView = frame()->document() == this ? frame()->view() : nullptr;
2209
2210     // Prevent Widget tree changes from committing until the RenderView is dead and gone.
2211     WidgetHierarchyUpdatesSuspensionScope suspendWidgetHierarchyUpdates;
2212
2213     SetForScope<bool> change(m_renderTreeBeingDestroyed, true);
2214
2215     if (this == &topDocument())
2216         clearAXObjectCache();
2217
2218     documentWillBecomeInactive();
2219
2220     if (frameView)
2221         frameView->willDestroyRenderTree();
2222
2223 #if ENABLE(FULLSCREEN_API)
2224     if (m_fullScreenRenderer)
2225         setFullScreenRenderer(nullptr);
2226 #endif
2227
2228     m_hoveredElement = nullptr;
2229     m_focusedElement = nullptr;
2230     m_activeElement = nullptr;
2231     m_focusNavigationStartingNode = nullptr;
2232
2233     if (m_documentElement)
2234         RenderTreeUpdater::tearDownRenderers(*m_documentElement);
2235
2236     clearChildNeedsStyleRecalc();
2237
2238     unscheduleStyleRecalc();
2239
2240     m_renderView = nullptr;
2241     Node::setRenderer(nullptr);
2242
2243 #if ENABLE(TEXT_AUTOSIZING)
2244     // Do this before the arena is cleared, which is needed to deref the RenderStyle on TextAutoSizingKey.
2245     m_textAutoSizedNodes.clear();
2246 #endif
2247
2248     if (frameView)
2249         frameView->didDestroyRenderTree();
2250 }
2251
2252 void Document::prepareForDestruction()
2253 {
2254     if (m_hasPreparedForDestruction)
2255         return;
2256
2257     if (m_frame)
2258         m_frame->animation().detachFromDocument(this);
2259
2260 #if ENABLE(IOS_TOUCH_EVENTS)
2261     clearTouchEventHandlersAndListeners();
2262 #endif
2263
2264 #if HAVE(ACCESSIBILITY)
2265     // Sub-frames need to cleanup Nodes in the text marker cache when the Document disappears.
2266     if (this != &topDocument()) {
2267         if (AXObjectCache* cache = existingAXObjectCache())
2268             cache->clearTextMarkerNodesInUse(this);
2269     }
2270 #endif
2271     
2272     disconnectDescendantFrames();
2273     if (m_domWindow && m_frame)
2274         m_domWindow->willDetachDocumentFromFrame();
2275
2276     if (hasLivingRenderTree())
2277         destroyRenderTree();
2278
2279     if (is<PluginDocument>(*this))
2280         downcast<PluginDocument>(*this).detachFromPluginElement();
2281
2282 #if ENABLE(POINTER_LOCK)
2283     if (page())
2284         page()->pointerLockController().documentDetached(*this);
2285 #endif
2286
2287     if (auto* page = this->page()) {
2288         if (auto* validationMessageClient = page->validationMessageClient())
2289             validationMessageClient->documentDetached(*this);
2290     }
2291
2292     InspectorInstrumentation::documentDetached(*this);
2293
2294     stopActiveDOMObjects();
2295     m_eventQueue.close();
2296 #if ENABLE(FULLSCREEN_API)
2297     m_fullScreenChangeEventTargetQueue.clear();
2298     m_fullScreenErrorEventTargetQueue.clear();
2299 #endif
2300
2301     commonTeardown();
2302
2303 #if ENABLE(TOUCH_EVENTS)
2304     if (m_touchEventTargets && m_touchEventTargets->size() && parentDocument())
2305         parentDocument()->didRemoveEventTargetNode(*this);
2306 #endif
2307
2308     if (m_wheelEventTargets && m_wheelEventTargets->size() && parentDocument())
2309         parentDocument()->didRemoveEventTargetNode(*this);
2310
2311     if (m_mediaQueryMatcher)
2312         m_mediaQueryMatcher->documentDestroyed();
2313
2314 #if ENABLE(WIRELESS_PLAYBACK_TARGET)
2315     if (!m_clientToIDMap.isEmpty() && page()) {
2316         Vector<WebCore::MediaPlaybackTargetClient*> clients;
2317         copyKeysToVector(m_clientToIDMap, clients);
2318         for (auto* client : clients)
2319             removePlaybackTargetPickerClient(*client);
2320     }
2321 #endif
2322
2323     detachFromFrame();
2324
2325     m_hasPreparedForDestruction = true;
2326 }
2327
2328 void Document::removeAllEventListeners()
2329 {
2330     EventTarget::removeAllEventListeners();
2331
2332     if (m_domWindow)
2333         m_domWindow->removeAllEventListeners();
2334 #if ENABLE(IOS_TOUCH_EVENTS)
2335     clearTouchEventHandlersAndListeners();
2336 #endif
2337     for (Node* node = firstChild(); node; node = NodeTraversal::next(*node))
2338         node->removeAllEventListeners();
2339
2340 #if ENABLE(TOUCH_EVENTS)
2341     m_touchEventTargets = nullptr;
2342 #endif
2343     m_wheelEventTargets = nullptr;
2344 }
2345
2346 void Document::suspendDeviceMotionAndOrientationUpdates()
2347 {
2348     if (m_areDeviceMotionAndOrientationUpdatesSuspended)
2349         return;
2350     m_areDeviceMotionAndOrientationUpdatesSuspended = true;
2351 #if ENABLE(DEVICE_ORIENTATION) && PLATFORM(IOS)
2352     if (m_deviceMotionController)
2353         m_deviceMotionController->suspendUpdates();
2354     if (m_deviceOrientationController)
2355         m_deviceOrientationController->suspendUpdates();
2356 #endif
2357 }
2358
2359 void Document::resumeDeviceMotionAndOrientationUpdates()
2360 {
2361     if (!m_areDeviceMotionAndOrientationUpdatesSuspended)
2362         return;
2363     m_areDeviceMotionAndOrientationUpdatesSuspended = false;
2364 #if ENABLE(DEVICE_ORIENTATION) && PLATFORM(IOS)
2365     if (m_deviceMotionController)
2366         m_deviceMotionController->resumeUpdates();
2367     if (m_deviceOrientationController)
2368         m_deviceOrientationController->resumeUpdates();
2369 #endif
2370 }
2371
2372 bool Document::shouldBypassMainWorldContentSecurityPolicy() const
2373 {
2374     JSC::CallFrame* callFrame = commonVM().topCallFrame;
2375     if (callFrame == JSC::CallFrame::noCaller())
2376         return false;
2377     DOMWrapperWorld& domWrapperWorld = currentWorld(callFrame);
2378     if (domWrapperWorld.isNormal())
2379         return false;
2380     return true;
2381 }
2382
2383 void Document::platformSuspendOrStopActiveDOMObjects()
2384 {
2385 #if PLATFORM(IOS)
2386     if (WebThreadCountOfObservedContentModifiers() > 0) {
2387         if (auto* frame = this->frame()) {
2388             if (auto* page = frame->page())
2389                 page->chrome().client().clearContentChangeObservers(*frame);
2390         }
2391     }
2392 #endif
2393 }
2394
2395 void Document::suspendActiveDOMObjects(ActiveDOMObject::ReasonForSuspension why)
2396 {
2397     ScriptExecutionContext::suspendActiveDOMObjects(why);
2398     suspendDeviceMotionAndOrientationUpdates();
2399     platformSuspendOrStopActiveDOMObjects();
2400 }
2401
2402 void Document::resumeActiveDOMObjects(ActiveDOMObject::ReasonForSuspension why)
2403 {
2404     ScriptExecutionContext::resumeActiveDOMObjects(why);
2405     resumeDeviceMotionAndOrientationUpdates();
2406     // FIXME: For iOS, do we need to add content change observers that were removed in Document::suspendActiveDOMObjects()?
2407 }
2408
2409 void Document::stopActiveDOMObjects()
2410 {
2411     ScriptExecutionContext::stopActiveDOMObjects();
2412     platformSuspendOrStopActiveDOMObjects();
2413 }
2414
2415 void Document::clearAXObjectCache()
2416 {
2417     ASSERT(&topDocument() == this);
2418     // Clear the cache member variable before calling delete because attempts
2419     // are made to access it during destruction.
2420     m_axObjectCache = nullptr;
2421 }
2422
2423 AXObjectCache* Document::existingAXObjectCacheSlow() const
2424 {
2425     ASSERT(hasEverCreatedAnAXObjectCache);
2426     Document& topDocument = this->topDocument();
2427     if (!topDocument.hasLivingRenderTree())
2428         return nullptr;
2429     return topDocument.m_axObjectCache.get();
2430 }
2431
2432 AXObjectCache* Document::axObjectCache() const
2433 {
2434     if (!AXObjectCache::accessibilityEnabled())
2435         return nullptr;
2436     
2437     // The only document that actually has a AXObjectCache is the top-level
2438     // document.  This is because we need to be able to get from any WebCoreAXObject
2439     // to any other WebCoreAXObject on the same page.  Using a single cache allows
2440     // lookups across nested webareas (i.e. multiple documents).
2441     Document& topDocument = this->topDocument();
2442
2443     // If the document has already been detached, do not make a new axObjectCache.
2444     if (!topDocument.hasLivingRenderTree())
2445         return nullptr;
2446
2447     ASSERT(&topDocument == this || !m_axObjectCache);
2448     if (!topDocument.m_axObjectCache) {
2449         topDocument.m_axObjectCache = std::make_unique<AXObjectCache>(topDocument);
2450         hasEverCreatedAnAXObjectCache = true;
2451     }
2452     return topDocument.m_axObjectCache.get();
2453 }
2454
2455 void Document::setVisuallyOrdered()
2456 {
2457     m_visuallyOrdered = true;
2458     if (renderView())
2459         renderView()->mutableStyle().setRTLOrdering(VisualOrder);
2460 }
2461
2462 Ref<DocumentParser> Document::createParser()
2463 {
2464     // FIXME: this should probably pass the frame instead
2465     return XMLDocumentParser::create(*this, view());
2466 }
2467
2468 ScriptableDocumentParser* Document::scriptableDocumentParser() const
2469 {
2470     return parser() ? parser()->asScriptableDocumentParser() : nullptr;
2471 }
2472
2473 void Document::open(Document* ownerDocument)
2474 {
2475     if (m_ignoreOpensDuringUnloadCount)
2476         return;
2477
2478     if (ownerDocument) {
2479         setURL(ownerDocument->url());
2480         setCookieURL(ownerDocument->cookieURL());
2481         setSecurityOriginPolicy(ownerDocument->securityOriginPolicy());
2482     }
2483
2484     if (m_frame) {
2485         if (ScriptableDocumentParser* parser = scriptableDocumentParser()) {
2486             if (parser->isParsing()) {
2487                 // FIXME: HTML5 doesn't tell us to check this, it might not be correct.
2488                 if (parser->isExecutingScript())
2489                     return;
2490
2491                 if (!parser->wasCreatedByScript() && parser->hasInsertionPoint())
2492                     return;
2493             }
2494         }
2495
2496         if (m_frame->loader().state() == FrameStateProvisional)
2497             m_frame->loader().stopAllLoaders();
2498     }
2499
2500     removeAllEventListeners();
2501     implicitOpen();
2502     if (ScriptableDocumentParser* parser = scriptableDocumentParser())
2503         parser->setWasCreatedByScript(true);
2504
2505     if (m_frame)
2506         m_frame->loader().didExplicitOpen();
2507 }
2508
2509 void Document::detachParser()
2510 {
2511     if (!m_parser)
2512         return;
2513     m_parser->detach();
2514     m_parser = nullptr;
2515 }
2516
2517 void Document::cancelParsing()
2518 {
2519     if (!m_parser)
2520         return;
2521
2522     // We have to clear the parser to avoid possibly triggering
2523     // the onload handler when closing as a side effect of a cancel-style
2524     // change, such as opening a new document or closing the window while
2525     // still parsing
2526     detachParser();
2527     explicitClose();
2528 }
2529
2530 void Document::implicitOpen()
2531 {
2532     removeChildren();
2533
2534     setCompatibilityMode(DocumentCompatibilityMode::NoQuirksMode);
2535
2536     cancelParsing();
2537     m_parser = createParser();
2538     setParsing(true);
2539     setReadyState(Loading);
2540 }
2541
2542 HTMLBodyElement* Document::body() const
2543 {
2544     auto* element = documentElement();
2545     if (!element)
2546         return nullptr;
2547     return childrenOfType<HTMLBodyElement>(*element).first();
2548 }
2549
2550 HTMLElement* Document::bodyOrFrameset() const
2551 {
2552     // Return the first body or frameset child of the html element.
2553     auto* element = documentElement();
2554     if (!is<HTMLHtmlElement>(element))
2555         return nullptr;
2556     for (auto& child : childrenOfType<HTMLElement>(*element)) {
2557         if (is<HTMLBodyElement>(child) || is<HTMLFrameSetElement>(child))
2558             return &child;
2559     }
2560     return nullptr;
2561 }
2562
2563 ExceptionOr<void> Document::setBodyOrFrameset(RefPtr<HTMLElement>&& newBody)
2564 {
2565     if (!is<HTMLBodyElement>(newBody.get()) && !is<HTMLFrameSetElement>(newBody.get()))
2566         return Exception { HIERARCHY_REQUEST_ERR };
2567
2568     auto* currentBody = bodyOrFrameset();
2569     if (newBody == currentBody)
2570         return { };
2571
2572     if (!m_documentElement)
2573         return Exception { HIERARCHY_REQUEST_ERR };
2574
2575     if (currentBody)
2576         return m_documentElement->replaceChild(*newBody, *currentBody);
2577     return m_documentElement->appendChild(*newBody);
2578 }
2579
2580 Location* Document::location() const
2581 {
2582     auto* window = domWindow();
2583     if (!window)
2584         return nullptr;
2585
2586     return window->location();
2587 }
2588
2589 HTMLHeadElement* Document::head()
2590 {
2591     if (auto element = documentElement())
2592         return childrenOfType<HTMLHeadElement>(*element).first();
2593     return nullptr;
2594 }
2595
2596 void Document::close()
2597 {
2598     // FIXME: We should follow the specification more closely:
2599     //        http://www.whatwg.org/specs/web-apps/current-work/#dom-document-close
2600
2601     if (!scriptableDocumentParser() || !scriptableDocumentParser()->wasCreatedByScript() || !scriptableDocumentParser()->isParsing())
2602         return;
2603
2604     explicitClose();
2605 }
2606
2607 void Document::explicitClose()
2608 {
2609     if (RefPtr<DocumentParser> parser = m_parser)
2610         parser->finish();
2611
2612     if (!m_frame) {
2613         // Because we have no frame, we don't know if all loading has completed,
2614         // so we just call implicitClose() immediately. FIXME: This might fire
2615         // the load event prematurely <http://bugs.webkit.org/show_bug.cgi?id=14568>.
2616         implicitClose();
2617         return;
2618     }
2619
2620     m_frame->loader().checkCompleted();
2621 }
2622
2623 void Document::implicitClose()
2624 {
2625     // If we're in the middle of recalcStyle, we need to defer the close until the style information is accurate and all elements are re-attached.
2626     if (m_inStyleRecalc) {
2627         m_closeAfterStyleRecalc = true;
2628         return;
2629     }
2630
2631     bool wasLocationChangePending = frame() && frame()->navigationScheduler().locationChangePending();
2632     bool doload = !parsing() && m_parser && !m_processingLoadEvent && !wasLocationChangePending;
2633     
2634     if (!doload)
2635         return;
2636
2637     // Call to dispatchWindowLoadEvent can blow us from underneath.
2638     Ref<Document> protectedThis(*this);
2639
2640     m_processingLoadEvent = true;
2641
2642     ScriptableDocumentParser* parser = scriptableDocumentParser();
2643     m_wellFormed = parser && parser->wellFormed();
2644
2645     // We have to clear the parser, in case someone document.write()s from the
2646     // onLoad event handler, as in Radar 3206524.
2647     detachParser();
2648
2649     // FIXME: We kick off the icon loader when the Document is done parsing.
2650     // There are earlier opportunities we could start it:
2651     //  -When the <head> finishes parsing
2652     //  -When any new HTMLLinkElement is inserted into the document
2653     // But those add a dynamic component to the favicon that has UI 
2654     // ramifications, and we need to decide what is the Right Thing To Do(tm)
2655     Frame* f = frame();
2656     if (f) {
2657         if (f->loader().client().useIconLoadingClient()) {
2658             if (auto* documentLoader = loader())
2659                 documentLoader->startIconLoading();
2660         } else
2661             f->loader().icon().startLoader();
2662
2663         f->animation().startAnimationsIfNotSuspended(this);
2664
2665         // FIXME: We shouldn't be dispatching pending events globally on all Documents here.
2666         // For now, only do this when there is a Frame, otherwise this could cause JS reentrancy
2667         // below SVG font parsing, for example. <https://webkit.org/b/136269>
2668         ImageLoader::dispatchPendingBeforeLoadEvents();
2669         ImageLoader::dispatchPendingLoadEvents();
2670         ImageLoader::dispatchPendingErrorEvents();
2671         HTMLLinkElement::dispatchPendingLoadEvents();
2672         HTMLStyleElement::dispatchPendingLoadEvents();
2673     }
2674
2675     // To align the HTML load event and the SVGLoad event for the outermost <svg> element, fire it from
2676     // here, instead of doing it from SVGElement::finishedParsingChildren (if externalResourcesRequired="false",
2677     // which is the default, for ='true' its fired at a later time, once all external resources finished loading).
2678     if (svgExtensions())
2679         accessSVGExtensions().dispatchSVGLoadEventToOutermostSVGElements();
2680
2681     dispatchWindowLoadEvent();
2682     enqueuePageshowEvent(PageshowEventNotPersisted);
2683     if (m_pendingStateObject)
2684         enqueuePopstateEvent(WTFMove(m_pendingStateObject));
2685
2686     if (f)
2687         f->loader().dispatchOnloadEvents();
2688
2689     // An event handler may have removed the frame
2690     if (!frame()) {
2691         m_processingLoadEvent = false;
2692         return;
2693     }
2694
2695     // Make sure both the initial layout and reflow happen after the onload
2696     // fires. This will improve onload scores, and other browsers do it.
2697     // If they wanna cheat, we can too. -dwh
2698
2699     if (frame()->navigationScheduler().locationChangePending() && timeSinceDocumentCreation() < settings().layoutInterval()) {
2700         // Just bail out. Before or during the onload we were shifted to another page.
2701         // The old i-Bench suite does this. When this happens don't bother painting or laying out.        
2702         m_processingLoadEvent = false;
2703         view()->unscheduleRelayout();
2704         return;
2705     }
2706
2707     frame()->loader().checkCallImplicitClose();
2708     
2709     // We used to force a synchronous display and flush here.  This really isn't
2710     // necessary and can in fact be actively harmful if pages are loading at a rate of > 60fps
2711     // (if your platform is syncing flushes and limiting them to 60fps).
2712     m_overMinimumLayoutThreshold = true;
2713     if (!ownerElement() || (ownerElement()->renderer() && !ownerElement()->renderer()->needsLayout())) {
2714         updateStyleIfNeeded();
2715         
2716         // Always do a layout after loading if needed.
2717         if (view() && renderView() && (!renderView()->firstChild() || renderView()->needsLayout()))
2718             view()->layout();
2719     }
2720
2721     m_processingLoadEvent = false;
2722
2723 #if PLATFORM(COCOA) || PLATFORM(WIN) || PLATFORM(GTK) || PLATFORM(EFL)
2724     if (f && hasLivingRenderTree() && AXObjectCache::accessibilityEnabled()) {
2725         // The AX cache may have been cleared at this point, but we need to make sure it contains an
2726         // AX object to send the notification to. getOrCreate will make sure that an valid AX object
2727         // exists in the cache (we ignore the return value because we don't need it here). This is 
2728         // only safe to call when a layout is not in progress, so it can not be used in postNotification.
2729         //
2730         // This notification is now called AXNewDocumentLoadComplete because there are other handlers that will
2731         // catch new AND page history loads, and that uses AXLoadComplete
2732         
2733         axObjectCache()->getOrCreate(renderView());
2734         if (this == &topDocument())
2735             axObjectCache()->postNotification(renderView(), AXObjectCache::AXNewDocumentLoadComplete);
2736         else {
2737             // AXLoadComplete can only be posted on the top document, so if it's a document
2738             // in an iframe that just finished loading, post AXLayoutComplete instead.
2739             axObjectCache()->postNotification(renderView(), AXObjectCache::AXLayoutComplete);
2740         }
2741     }
2742 #endif
2743
2744     if (svgExtensions())
2745         accessSVGExtensions().startAnimations();
2746 }
2747
2748 void Document::setParsing(bool b)
2749 {
2750     m_bParsing = b;
2751
2752     if (m_bParsing && !m_sharedObjectPool)
2753         m_sharedObjectPool = std::make_unique<DocumentSharedObjectPool>();
2754
2755     if (!m_bParsing && view() && !view()->needsLayout())
2756         view()->fireLayoutRelatedMilestonesIfNeeded();
2757 }
2758
2759 bool Document::shouldScheduleLayout()
2760 {
2761     // This function will only be called when FrameView thinks a layout is needed.
2762     // This enforces a couple extra rules.
2763     //
2764     //    (a) Only schedule a layout once the stylesheets are loaded.
2765     //    (b) Only schedule layout once we have a body element.
2766
2767     return (haveStylesheetsLoaded() && bodyOrFrameset())
2768         || (documentElement() && !is<HTMLHtmlElement>(*documentElement()));
2769 }
2770     
2771 bool Document::isLayoutTimerActive()
2772 {
2773     return view() && view()->layoutPending() && !minimumLayoutDelay();
2774 }
2775
2776 Seconds Document::minimumLayoutDelay()
2777 {
2778     if (m_overMinimumLayoutThreshold)
2779         return 0_s;
2780     
2781     auto elapsed = timeSinceDocumentCreation();
2782     m_overMinimumLayoutThreshold = elapsed > settings().layoutInterval();
2783
2784     // We'll want to schedule the timer to fire at the minimum layout threshold.
2785     return std::max(0_s, settings().layoutInterval() - elapsed);
2786 }
2787
2788 Seconds Document::timeSinceDocumentCreation() const
2789 {
2790     return MonotonicTime::now() - m_documentCreationTime;
2791 }
2792
2793 void Document::write(SegmentedString&& text, Document* ownerDocument)
2794 {
2795     NestingLevelIncrementer nestingLevelIncrementer(m_writeRecursionDepth);
2796
2797     m_writeRecursionIsTooDeep = (m_writeRecursionDepth > 1) && m_writeRecursionIsTooDeep;
2798     m_writeRecursionIsTooDeep = (m_writeRecursionDepth > cMaxWriteRecursionDepth) || m_writeRecursionIsTooDeep;
2799
2800     if (m_writeRecursionIsTooDeep)
2801         return;
2802
2803     bool hasInsertionPoint = m_parser && m_parser->hasInsertionPoint();
2804     if (!hasInsertionPoint && (m_ignoreOpensDuringUnloadCount || m_ignoreDestructiveWriteCount))
2805         return;
2806
2807     if (!hasInsertionPoint)
2808         open(ownerDocument);
2809
2810     ASSERT(m_parser);
2811     m_parser->insert(WTFMove(text));
2812 }
2813
2814 void Document::write(const String& text, Document* ownerDocument)
2815 {
2816     write(SegmentedString { text }, ownerDocument);
2817 }
2818
2819 void Document::writeln(const String& text, Document* ownerDocument)
2820 {
2821     SegmentedString textWithNewline { text };
2822     textWithNewline.append(String { "\n" });
2823     write(WTFMove(textWithNewline), ownerDocument);
2824 }
2825
2826 std::chrono::milliseconds Document::minimumTimerInterval() const
2827 {
2828     auto* page = this->page();
2829     if (!page)
2830         return ScriptExecutionContext::minimumTimerInterval();
2831     return page->settings().minimumDOMTimerInterval();
2832 }
2833
2834 void Document::setTimerThrottlingEnabled(bool shouldThrottle)
2835 {
2836     if (m_isTimerThrottlingEnabled == shouldThrottle)
2837         return;
2838
2839     m_isTimerThrottlingEnabled = shouldThrottle;
2840     didChangeTimerAlignmentInterval();
2841 }
2842
2843 std::chrono::milliseconds Document::timerAlignmentInterval(bool hasReachedMaxNestingLevel) const
2844 {
2845     auto alignmentInterval = ScriptExecutionContext::timerAlignmentInterval(hasReachedMaxNestingLevel);
2846
2847     // Apply Document-level DOMTimer throttling only if timers have reached their maximum nesting level as the Page may still be visible.
2848     if (m_isTimerThrottlingEnabled && hasReachedMaxNestingLevel)
2849         alignmentInterval = std::max(alignmentInterval, DOMTimer::hiddenPageAlignmentInterval());
2850
2851     if (Page* page = this->page())
2852         alignmentInterval = std::max(alignmentInterval, page->domTimerAlignmentInterval());
2853
2854     return alignmentInterval;
2855 }
2856
2857 EventTarget* Document::errorEventTarget()
2858 {
2859     return m_domWindow.get();
2860 }
2861
2862 void Document::logExceptionToConsole(const String& errorMessage, const String& sourceURL, int lineNumber, int columnNumber, RefPtr<Inspector::ScriptCallStack>&& callStack)
2863 {
2864     addMessage(MessageSource::JS, MessageLevel::Error, errorMessage, sourceURL, lineNumber, columnNumber, WTFMove(callStack));
2865 }
2866
2867 void Document::setURL(const URL& url)
2868 {
2869     const URL& newURL = url.isEmpty() ? blankURL() : url;
2870     if (newURL == m_url)
2871         return;
2872
2873     m_url = newURL;
2874     m_documentURI = m_url.string();
2875     updateBaseURL();
2876 }
2877
2878 void Document::updateBaseURL()
2879 {
2880     URL oldBaseURL = m_baseURL;
2881     // DOM 3 Core: When the Document supports the feature "HTML" [DOM Level 2 HTML], the base URI is computed using
2882     // first the value of the href attribute of the HTML BASE element if any, and the value of the documentURI attribute
2883     // from the Document interface otherwise.
2884     if (!m_baseElementURL.isEmpty())
2885         m_baseURL = m_baseElementURL;
2886     else if (!m_baseURLOverride.isEmpty())
2887         m_baseURL = m_baseURLOverride;
2888     else {
2889         // The documentURI attribute is read-only from JavaScript, but writable from Objective C, so we need to retain
2890         // this fallback behavior. We use a null base URL, since the documentURI attribute is an arbitrary string
2891         // and DOM 3 Core does not specify how it should be resolved.
2892         m_baseURL = URL(ParsedURLString, documentURI());
2893     }
2894
2895     clearSelectorQueryCache();
2896
2897     if (!m_baseURL.isValid())
2898         m_baseURL = URL();
2899
2900     if (!equalIgnoringFragmentIdentifier(oldBaseURL, m_baseURL)) {
2901         // Base URL change changes any relative visited links.
2902         // FIXME: There are other URLs in the tree that would need to be re-evaluated on dynamic base URL change. Style should be invalidated too.
2903         for (auto& anchor : descendantsOfType<HTMLAnchorElement>(*this))
2904             anchor.invalidateCachedVisitedLinkHash();
2905     }
2906 }
2907
2908 void Document::setBaseURLOverride(const URL& url)
2909 {
2910     m_baseURLOverride = url;
2911     updateBaseURL();
2912 }
2913
2914 void Document::processBaseElement()
2915 {
2916     // Find the first href attribute in a base element and the first target attribute in a base element.
2917     const AtomicString* href = nullptr;
2918     const AtomicString* target = nullptr;
2919     auto baseDescendants = descendantsOfType<HTMLBaseElement>(*this);
2920     for (auto& base : baseDescendants) {
2921         if (!href) {
2922             const AtomicString& value = base.attributeWithoutSynchronization(hrefAttr);
2923             if (!value.isNull()) {
2924                 href = &value;
2925                 if (target)
2926                     break;
2927             }
2928         }
2929         if (!target) {
2930             const AtomicString& value = base.attributeWithoutSynchronization(targetAttr);
2931             if (!value.isNull()) {
2932                 target = &value;
2933                 if (href)
2934                     break;
2935             }
2936         }
2937     }
2938
2939     // FIXME: Since this doesn't share code with completeURL it may not handle encodings correctly.
2940     URL baseElementURL;
2941     if (href) {
2942         String strippedHref = stripLeadingAndTrailingHTMLSpaces(*href);
2943         if (!strippedHref.isEmpty())
2944             baseElementURL = URL(url(), strippedHref);
2945     }
2946     if (m_baseElementURL != baseElementURL && contentSecurityPolicy()->allowBaseURI(baseElementURL)) {
2947         m_baseElementURL = baseElementURL;
2948         updateBaseURL();
2949     }
2950
2951     m_baseTarget = target ? *target : nullAtom;
2952 }
2953
2954 String Document::userAgent(const URL& url) const
2955 {
2956     return frame() ? frame()->loader().userAgent(url) : String();
2957 }
2958
2959 void Document::disableEval(const String& errorMessage)
2960 {
2961     if (!frame())
2962         return;
2963
2964     frame()->script().disableEval(errorMessage);
2965 }
2966
2967 #if ENABLE(INDEXED_DATABASE)
2968
2969 IDBClient::IDBConnectionProxy* Document::idbConnectionProxy()
2970 {
2971     if (!m_idbConnectionProxy) {
2972         Page* currentPage = page();
2973         if (!currentPage)
2974             return nullptr;
2975         m_idbConnectionProxy = &currentPage->idbConnection().proxy();
2976     }
2977     return m_idbConnectionProxy.get();
2978 }
2979
2980 #endif
2981
2982 #if ENABLE(WEB_SOCKETS)
2983
2984 SocketProvider* Document::socketProvider()
2985 {
2986     return m_socketProvider.get();
2987 }
2988
2989 #endif
2990     
2991 bool Document::canNavigate(Frame* targetFrame)
2992 {
2993     if (!m_frame)
2994         return false;
2995
2996     // FIXME: We shouldn't call this function without a target frame, but
2997     // fast/forms/submit-to-blank-multiple-times.html depends on this function
2998     // returning true when supplied with a 0 targetFrame.
2999     if (!targetFrame)
3000         return true;
3001
3002     // Frame-busting is generally allowed, but blocked for sandboxed frames lacking the 'allow-top-navigation' flag.
3003     if (!isSandboxed(SandboxTopNavigation) && targetFrame == &m_frame->tree().top())
3004         return true;
3005
3006     if (isSandboxed(SandboxNavigation)) {
3007         if (targetFrame->tree().isDescendantOf(m_frame))
3008             return true;
3009
3010         const char* reason = "The frame attempting navigation is sandboxed, and is therefore disallowed from navigating its ancestors.";
3011         if (isSandboxed(SandboxTopNavigation) && targetFrame == &m_frame->tree().top())
3012             reason = "The frame attempting navigation of the top-level window is sandboxed, but the 'allow-top-navigation' flag is not set.";
3013
3014         printNavigationErrorMessage(targetFrame, url(), reason);
3015         return false;
3016     }
3017
3018     // This is the normal case. A document can navigate its decendant frames,
3019     // or, more generally, a document can navigate a frame if the document is
3020     // in the same origin as any of that frame's ancestors (in the frame
3021     // hierarchy).
3022     //
3023     // See http://www.adambarth.com/papers/2008/barth-jackson-mitchell.pdf for
3024     // historical information about this security check.
3025     if (canAccessAncestor(securityOrigin(), targetFrame))
3026         return true;
3027
3028     // Top-level frames are easier to navigate than other frames because they
3029     // display their URLs in the address bar (in most browsers). However, there
3030     // are still some restrictions on navigation to avoid nuisance attacks.
3031     // Specifically, a document can navigate a top-level frame if that frame
3032     // opened the document or if the document is the same-origin with any of
3033     // the top-level frame's opener's ancestors (in the frame hierarchy).
3034     //
3035     // In both of these cases, the document performing the navigation is in
3036     // some way related to the frame being navigate (e.g., by the "opener"
3037     // and/or "parent" relation). Requiring some sort of relation prevents a
3038     // document from navigating arbitrary, unrelated top-level frames.
3039     if (!targetFrame->tree().parent()) {
3040         if (targetFrame == m_frame->loader().opener())
3041             return true;
3042
3043         if (canAccessAncestor(securityOrigin(), targetFrame->loader().opener()))
3044             return true;
3045     }
3046
3047     printNavigationErrorMessage(targetFrame, url(), "The frame attempting navigation is neither same-origin with the target, nor is it the target's parent or opener.");
3048     return false;
3049 }
3050
3051 Frame* Document::findUnsafeParentScrollPropagationBoundary()
3052 {
3053     Frame* currentFrame = m_frame;
3054     if (!currentFrame)
3055         return nullptr;
3056
3057     Frame* ancestorFrame = currentFrame->tree().parent();
3058
3059     while (ancestorFrame) {
3060         if (!ancestorFrame->document()->securityOrigin().canAccess(securityOrigin()))
3061             return currentFrame;
3062         currentFrame = ancestorFrame;
3063         ancestorFrame = ancestorFrame->tree().parent();
3064     }
3065     return nullptr;
3066 }
3067
3068 void Document::didRemoveAllPendingStylesheet()
3069 {
3070     m_needsNotifyRemoveAllPendingStylesheet = false;
3071
3072     if (m_pendingSheetLayout == DidLayoutWithPendingSheets) {
3073         m_pendingSheetLayout = IgnoreLayoutWithPendingSheets;
3074         if (renderView())
3075             renderView()->repaintViewAndCompositedLayers();
3076     }
3077
3078     if (ScriptableDocumentParser* parser = scriptableDocumentParser())
3079         parser->executeScriptsWaitingForStylesheets();
3080
3081     if (m_gotoAnchorNeededAfterStylesheetsLoad && view())
3082         view()->scrollToFragment(m_url);
3083 }
3084
3085 bool Document::usesStyleBasedEditability() const
3086 {
3087     if (m_hasElementUsingStyleBasedEditability)
3088         return true;
3089
3090     ASSERT(!m_renderView || !m_renderView->frameView().isPainting());
3091     ASSERT(!m_inStyleRecalc);
3092
3093     auto& styleScope = const_cast<Style::Scope&>(this->styleScope());
3094     styleScope.flushPendingUpdate();
3095     return styleScope.usesStyleBasedEditability();
3096 }
3097
3098 void Document::setHasElementUsingStyleBasedEditability()
3099 {
3100     m_hasElementUsingStyleBasedEditability = true;
3101 }
3102
3103 void Document::processHttpEquiv(const String& equiv, const String& content, bool isInDocumentHead)
3104 {
3105     ASSERT(!equiv.isNull());
3106     ASSERT(!content.isNull());
3107
3108     HttpEquivPolicy policy = httpEquivPolicy();
3109     if (policy != HttpEquivPolicy::Enabled) {
3110         String reason;
3111         switch (policy) {
3112         case HttpEquivPolicy::Enabled:
3113             ASSERT_NOT_REACHED();
3114             break;
3115         case HttpEquivPolicy::DisabledBySettings:
3116             reason = "by the embedder.";
3117             break;
3118         case HttpEquivPolicy::DisabledByContentDispositionAttachmentSandbox:
3119             reason = "for documents with Content-Disposition: attachment.";
3120             break;
3121         }
3122         String message = "http-equiv '" + equiv + "' is disabled " + reason;
3123         addConsoleMessage(MessageSource::Security, MessageLevel::Error, message);
3124         return;
3125     }
3126
3127     Frame* frame = this->frame();
3128
3129     HTTPHeaderName headerName;
3130     if (!findHTTPHeaderName(equiv, headerName))
3131         return;
3132
3133     switch (headerName) {
3134     case HTTPHeaderName::DefaultStyle:
3135         // The preferred style set has been overridden as per section
3136         // 14.3.2 of the HTML4.0 specification.  We need to update the
3137         // sheet used variable and then update our style selector.
3138         // For more info, see the test at:
3139         // http://www.hixie.ch/tests/evil/css/import/main/preferred.html
3140         // -dwh
3141         styleScope().setSelectedStylesheetSetName(content);
3142         styleScope().setPreferredStylesheetSetName(content);
3143         break;
3144
3145     case HTTPHeaderName::Refresh: {
3146         double delay;
3147         String urlString;
3148         if (frame && parseMetaHTTPEquivRefresh(content, delay, urlString)) {
3149             URL completedURL;
3150             if (urlString.isEmpty())
3151                 completedURL = m_url;
3152             else
3153                 completedURL = completeURL(urlString);
3154             if (!protocolIsJavaScript(completedURL))
3155                 frame->navigationScheduler().scheduleRedirect(*this, delay, completedURL);
3156             else {
3157                 String message = "Refused to refresh " + m_url.stringCenterEllipsizedToLength() + " to a javascript: URL";
3158                 addConsoleMessage(MessageSource::Security, MessageLevel::Error, message);
3159             }
3160         }
3161
3162         break;
3163     }
3164
3165     case HTTPHeaderName::SetCookie:
3166         // FIXME: make setCookie work on XML documents too; e.g. in case of <html:meta .....>
3167         if (is<HTMLDocument>(*this)) {
3168             // Exception (for sandboxed documents) ignored.
3169             downcast<HTMLDocument>(*this).setCookie(content);
3170         }
3171         break;
3172
3173     case HTTPHeaderName::ContentLanguage:
3174         setContentLanguage(content);
3175         break;
3176
3177     case HTTPHeaderName::XDNSPrefetchControl:
3178         parseDNSPrefetchControlHeader(content);
3179         break;
3180
3181     case HTTPHeaderName::XFrameOptions:
3182         if (frame) {
3183             FrameLoader& frameLoader = frame->loader();
3184             unsigned long requestIdentifier = 0;
3185             if (frameLoader.activeDocumentLoader() && frameLoader.activeDocumentLoader()->mainResourceLoader())
3186                 requestIdentifier = frameLoader.activeDocumentLoader()->mainResourceLoader()->identifier();
3187
3188             String message = "The X-Frame-Option '" + content + "' supplied in a <meta> element was ignored. X-Frame-Options may only be provided by an HTTP header sent with the document.";
3189             addConsoleMessage(MessageSource::Security, MessageLevel::Error, message, requestIdentifier);
3190         }
3191         break;
3192
3193     case HTTPHeaderName::ContentSecurityPolicy:
3194         if (isInDocumentHead)
3195             contentSecurityPolicy()->didReceiveHeader(content, ContentSecurityPolicyHeaderType::Enforce, ContentSecurityPolicy::PolicyFrom::HTTPEquivMeta);
3196         break;
3197
3198     case HTTPHeaderName::XWebKitCSP:
3199         if (isInDocumentHead)
3200             contentSecurityPolicy()->didReceiveHeader(content, ContentSecurityPolicyHeaderType::PrefixedEnforce, ContentSecurityPolicy::PolicyFrom::HTTPEquivMeta);
3201         break;
3202
3203     default:
3204         break;
3205     }
3206 }
3207
3208 void Document::processViewport(const String& features, ViewportArguments::Type origin)
3209 {
3210     ASSERT(!features.isNull());
3211
3212     if (origin < m_viewportArguments.type)
3213         return;
3214
3215     m_viewportArguments = ViewportArguments(origin);
3216
3217     processFeaturesString(features, [this](StringView key, StringView value) {
3218         setViewportFeature(m_viewportArguments, *this, key, value);
3219     });
3220
3221     updateViewportArguments();
3222 }
3223
3224 void Document::updateViewportArguments()
3225 {
3226     if (page() && frame()->isMainFrame()) {
3227 #ifndef NDEBUG
3228         m_didDispatchViewportPropertiesChanged = true;
3229 #endif
3230         page()->chrome().dispatchViewportPropertiesDidChange(m_viewportArguments);
3231         page()->chrome().didReceiveDocType(*frame());
3232     }
3233 }
3234
3235 #if PLATFORM(IOS)
3236
3237 void Document::processFormatDetection(const String& features)
3238 {
3239     // FIXME: Find a better place for this function.
3240     processFeaturesString(features, [this](StringView key, StringView value) {
3241         if (equalLettersIgnoringASCIICase(key, "telephone") && equalLettersIgnoringASCIICase(value, "no"))
3242             setIsTelephoneNumberParsingAllowed(false);
3243     });
3244 }
3245
3246 void Document::processWebAppOrientations()
3247 {
3248     if (Page* page = this->page())
3249         page->chrome().client().webAppOrientationsUpdated();
3250 }
3251
3252 #endif
3253
3254 void Document::processReferrerPolicy(const String& policy)
3255 {
3256     ASSERT(!policy.isNull());
3257
3258     // Documents in a Content-Disposition: attachment sandbox should never send a Referer header,
3259     // even if the document has a meta tag saying otherwise.
3260     if (shouldEnforceContentDispositionAttachmentSandbox())
3261         return;
3262
3263 #if USE(QUICK_LOOK)
3264     if (shouldEnforceQuickLookSandbox())
3265         return;
3266 #endif
3267
3268     // Note that we're supporting both the standard and legacy keywords for referrer
3269     // policies, as defined by http://www.w3.org/TR/referrer-policy/#referrer-policy-delivery-meta
3270     if (equalLettersIgnoringASCIICase(policy, "no-referrer") || equalLettersIgnoringASCIICase(policy, "never"))
3271         setReferrerPolicy(ReferrerPolicy::Never);
3272     else if (equalLettersIgnoringASCIICase(policy, "unsafe-url") || equalLettersIgnoringASCIICase(policy, "always"))
3273         setReferrerPolicy(ReferrerPolicy::Always);
3274     else if (equalLettersIgnoringASCIICase(policy, "origin"))
3275         setReferrerPolicy(ReferrerPolicy::Origin);
3276     else if (equalLettersIgnoringASCIICase(policy, "no-referrer-when-downgrade") || equalLettersIgnoringASCIICase(policy, "default"))
3277         setReferrerPolicy(ReferrerPolicy::Default);
3278     else {
3279         addConsoleMessage(MessageSource::Rendering, MessageLevel::Error, "Failed to set referrer policy: The value '" + policy + "' is not one of 'no-referrer', 'origin', 'no-referrer-when-downgrade', or 'unsafe-url'. Defaulting to 'no-referrer'.");
3280         setReferrerPolicy(ReferrerPolicy::Never);
3281     }
3282 }
3283
3284 MouseEventWithHitTestResults Document::prepareMouseEvent(const HitTestRequest& request, const LayoutPoint& documentPoint, const PlatformMouseEvent& event)
3285 {
3286     if (!hasLivingRenderTree())
3287         return MouseEventWithHitTestResults(event, HitTestResult(LayoutPoint()));
3288
3289     HitTestResult result(documentPoint);
3290     renderView()->hitTest(request, result);
3291
3292     if (!request.readOnly())
3293         updateHoverActiveState(request, result.targetElement());
3294
3295     return MouseEventWithHitTestResults(event, result);
3296 }
3297
3298 // DOM Section 1.1.1
3299 bool Document::childTypeAllowed(NodeType type) const
3300 {
3301     switch (type) {
3302     case ATTRIBUTE_NODE:
3303     case CDATA_SECTION_NODE:
3304     case DOCUMENT_FRAGMENT_NODE:
3305     case DOCUMENT_NODE:
3306     case TEXT_NODE:
3307         return false;
3308     case COMMENT_NODE:
3309     case PROCESSING_INSTRUCTION_NODE:
3310         return true;
3311     case DOCUMENT_TYPE_NODE:
3312     case ELEMENT_NODE:
3313         // Documents may contain no more than one of each of these.
3314         // (One Element and one DocumentType.)
3315         for (Node* c = firstChild(); c; c = c->nextSibling())
3316             if (c->nodeType() == type)
3317                 return false;
3318         return true;
3319     }
3320     return false;
3321 }
3322
3323 bool Document::canAcceptChild(const Node& newChild, const Node* refChild, AcceptChildOperation operation) const
3324 {
3325     if (operation == AcceptChildOperation::Replace && refChild->nodeType() == newChild.nodeType())
3326         return true;
3327
3328     switch (newChild.nodeType()) {
3329     case ATTRIBUTE_NODE:
3330     case CDATA_SECTION_NODE:
3331     case DOCUMENT_NODE:
3332     case TEXT_NODE:
3333         return false;
3334     case COMMENT_NODE:
3335     case PROCESSING_INSTRUCTION_NODE:
3336         return true;
3337     case DOCUMENT_FRAGMENT_NODE: {
3338         bool hasSeenElementChild = false;
3339         for (auto* node = downcast<DocumentFragment>(newChild).firstChild(); node; node = node->nextSibling()) {
3340             if (is<Element>(*node)) {
3341                 if (hasSeenElementChild)
3342                     return false;
3343                 hasSeenElementChild = true;
3344             }
3345             if (!canAcceptChild(*node, refChild, operation))
3346                 return false;
3347         }
3348         break;
3349     }
3350     case DOCUMENT_TYPE_NODE: {
3351         auto* existingDocType = childrenOfType<DocumentType>(*this).first();
3352         if (operation == AcceptChildOperation::Replace) {
3353             //  parent has a doctype child that is not child, or an element is preceding child.
3354             if (existingDocType && existingDocType != refChild)
3355                 return false;
3356             if (refChild->previousElementSibling())
3357                 return false;
3358         } else {
3359             ASSERT(operation == AcceptChildOperation::InsertOrAdd);
3360             if (existingDocType)
3361                 return false;
3362             if ((refChild && refChild->previousElementSibling()) || (!refChild && firstElementChild()))
3363                 return false;
3364         }
3365         break;
3366     }
3367     case ELEMENT_NODE: {
3368         auto* existingElementChild = firstElementChild();
3369         if (operation == AcceptChildOperation::Replace) {
3370             if (existingElementChild && existingElementChild != refChild)
3371                 return false;
3372             for (auto* child = refChild->nextSibling(); child; child = child->nextSibling()) {
3373                 if (is<DocumentType>(*child))
3374                     return false;
3375             }
3376         } else {
3377             ASSERT(operation == AcceptChildOperation::InsertOrAdd);
3378             if (existingElementChild)
3379                 return false;
3380             for (auto* child = refChild; child; child = child->nextSibling()) {
3381                 if (is<DocumentType>(*child))
3382                     return false;
3383             }
3384         }
3385         break;
3386     }
3387     }
3388     return true;
3389 }
3390
3391 Ref<Node> Document::cloneNodeInternal(Document&, CloningOperation type)
3392 {
3393     Ref<Document> clone = cloneDocumentWithoutChildren();
3394     clone->cloneDataFromDocument(*this);
3395     switch (type) {
3396     case CloningOperation::OnlySelf:
3397     case CloningOperation::SelfWithTemplateContent:
3398         break;
3399     case CloningOperation::Everything:
3400         cloneChildNodes(clone);
3401         break;
3402     }
3403     return WTFMove(clone);
3404 }
3405
3406 Ref<Document> Document::cloneDocumentWithoutChildren() const
3407 {
3408     if (isXMLDocument()) {
3409         if (isXHTMLDocument())
3410             return XMLDocument::createXHTML(nullptr, url());
3411         return XMLDocument::create(nullptr, url());
3412     }
3413     return create(nullptr, url());
3414 }
3415
3416 void Document::cloneDataFromDocument(const Document& other)
3417 {
3418     ASSERT(m_url == other.url());
3419     m_baseURL = other.baseURL();
3420     m_baseURLOverride = other.baseURLOverride();
3421     m_documentURI = other.documentURI();
3422
3423     setCompatibilityMode(other.m_compatibilityMode);
3424     setContextDocument(other.contextDocument());
3425     setSecurityOriginPolicy(other.securityOriginPolicy());
3426     overrideMIMEType(other.contentType());
3427     setDecoder(other.decoder());
3428 }
3429
3430 StyleSheetList& Document::styleSheets()
3431 {
3432     if (!m_styleSheetList)
3433         m_styleSheetList = StyleSheetList::create(this);
3434     return *m_styleSheetList;
3435 }
3436
3437 String Document::preferredStylesheetSet() const
3438 {
3439     return styleScope().preferredStylesheetSetName();
3440 }
3441
3442 String Document::selectedStylesheetSet() const
3443 {
3444     return styleScope().selectedStylesheetSetName();
3445 }
3446
3447 void Document::setSelectedStylesheetSet(const String& aString)
3448 {
3449     styleScope().setSelectedStylesheetSetName(aString);
3450 }
3451
3452 void Document::evaluateMediaQueryList()
3453 {
3454     if (m_mediaQueryMatcher)
3455         m_mediaQueryMatcher->styleResolverChanged();
3456     
3457     checkViewportDependentPictures();
3458 }
3459
3460 void Document::checkViewportDependentPictures()
3461 {
3462     Vector<HTMLPictureElement*, 16> changedPictures;
3463     HashSet<HTMLPictureElement*>::iterator end = m_viewportDependentPictures.end();
3464     for (HashSet<HTMLPictureElement*>::iterator it = m_viewportDependentPictures.begin(); it != end; ++it) {
3465         if ((*it)->viewportChangeAffectedPicture())
3466             changedPictures.append(*it);
3467     }
3468     for (auto* picture : changedPictures)
3469         picture->sourcesChanged();
3470 }
3471
3472 void Document::updateViewportUnitsOnResize()
3473 {
3474     if (!hasStyleWithViewportUnits())
3475         return;
3476
3477     styleScope().resolver().clearCachedPropertiesAffectedByViewportUnits();
3478
3479     // FIXME: Ideally, we should save the list of elements that have viewport units and only iterate over those.
3480     for (Element* element = ElementTraversal::firstWithin(rootNode()); element; element = ElementTraversal::nextIncludingPseudo(*element)) {
3481         auto* renderer = element->renderer();
3482         if (renderer && renderer->style().hasViewportUnits())
3483             element->invalidateStyle();
3484     }
3485 }
3486
3487 void Document::addAudioProducer(MediaProducer* audioProducer)
3488 {
3489     m_audioProducers.add(audioProducer);
3490     updateIsPlayingMedia();
3491 }
3492
3493 void Document::removeAudioProducer(MediaProducer* audioProducer)
3494 {
3495     m_audioProducers.remove(audioProducer);
3496     updateIsPlayingMedia();
3497 }
3498
3499 void Document::updateIsPlayingMedia(uint64_t sourceElementID)
3500 {
3501     MediaProducer::MediaStateFlags state = MediaProducer::IsNotPlaying;
3502     for (auto* audioProducer : m_audioProducers)
3503         state |= audioProducer->mediaState();
3504
3505 #if ENABLE(MEDIA_SESSION)
3506     if (HTMLMediaElement* sourceElement = HTMLMediaElement::elementWithID(sourceElementID)) {
3507         if (sourceElement->isPlaying())
3508             state |= MediaProducer::IsSourceElementPlaying;
3509
3510         if (auto* session = sourceElement->session()) {
3511             if (auto* controls = session->controls()) {
3512                 if (controls->previousTrackEnabled())
3513                     state |= MediaProducer::IsPreviousTrackControlEnabled;
3514                 if (controls->nextTrackEnabled())
3515                     state |= MediaProducer::IsNextTrackControlEnabled;
3516             }
3517         }
3518     }
3519 #endif
3520
3521     if (state == m_mediaState)
3522         return;
3523
3524     m_mediaState = state;
3525
3526     if (page())
3527         page()->updateIsPlayingMedia(sourceElementID);
3528 }
3529
3530 void Document::pageMutedStateDidChange()
3531 {
3532     for (auto* audioProducer : m_audioProducers)
3533         audioProducer->pageMutedStateDidChange();
3534 }
3535
3536 static bool isNodeInSubtree(Node& node, Node& container, bool amongChildrenOnly)
3537 {
3538     if (amongChildrenOnly)
3539         return node.isDescendantOf(container);
3540     else
3541         return &node == &container || node.isDescendantOf(container);
3542 }
3543
3544 void Document::removeFocusedNodeOfSubtree(Node& node, bool amongChildrenOnly)
3545 {
3546     if (!m_focusedElement || pageCacheState() != NotInPageCache) // If the document is in the page cache, then we don't need to clear out the focused node.
3547         return;
3548
3549     Element* focusedElement = node.treeScope().focusedElementInScope();
3550     if (!focusedElement)
3551         return;
3552     
3553     if (isNodeInSubtree(*focusedElement, node, amongChildrenOnly)) {
3554         setFocusedElement(nullptr, FocusDirectionNone, FocusRemovalEventsMode::DoNotDispatch);
3555         // Set the focus navigation starting node to the previous focused element so that
3556         // we can fallback to the siblings or parent node for the next search.
3557         // Also we need to call removeFocusNavigationNodeOfSubtree after this function because
3558         // setFocusedElement(nullptr) will reset m_focusNavigationStartingNode.
3559         setFocusNavigationStartingNode(focusedElement);
3560     }
3561 }
3562
3563 void Document::hoveredElementDidDetach(Element* element)
3564 {
3565     if (!m_hoveredElement || element != m_hoveredElement)
3566         return;
3567
3568     m_hoveredElement = element->parentElement();
3569     while (m_hoveredElement && !m_hoveredElement->renderer())
3570         m_hoveredElement = m_hoveredElement->parentElement();
3571     if (frame())
3572         frame()->eventHandler().scheduleHoverStateUpdate();
3573 }
3574
3575 void Document::elementInActiveChainDidDetach(Element* element)
3576 {
3577     if (!m_activeElement || element != m_activeElement)
3578         return;
3579
3580     m_activeElement = element->parentElement();
3581     while (m_activeElement && !m_activeElement->renderer())
3582         m_activeElement = m_activeElement->parentElement();
3583 }
3584
3585 #if ENABLE(DASHBOARD_SUPPORT)
3586
3587 const Vector<AnnotatedRegionValue>& Document::annotatedRegions() const
3588 {
3589     return m_annotatedRegions;
3590 }
3591
3592 void Document::setAnnotatedRegions(const Vector<AnnotatedRegionValue>& regions)
3593 {
3594     m_annotatedRegions = regions;
3595     setAnnotatedRegionsDirty(false);
3596 }
3597
3598 #endif
3599
3600 bool Document::setFocusedElement(Element* element, FocusDirection direction, FocusRemovalEventsMode eventsMode)
3601 {
3602     RefPtr<Element> newFocusedElement = element;
3603     // Make sure newFocusedElement is actually in this document
3604     if (newFocusedElement && (&newFocusedElement->document() != this))
3605         return true;
3606
3607     if (m_focusedElement == newFocusedElement)
3608         return true;
3609
3610     if (pageCacheState() != NotInPageCache)
3611         return false;
3612
3613     bool focusChangeBlocked = false;
3614     RefPtr<Element> oldFocusedElement = WTFMove(m_focusedElement);
3615
3616     // Remove focus from the existing focus node (if any)
3617     if (oldFocusedElement) {
3618         oldFocusedElement->setFocus(false);
3619         setFocusNavigationStartingNode(nullptr);
3620
3621         if (eventsMode == FocusRemovalEventsMode::Dispatch) {
3622             // Dispatch a change event for form control elements that have been edited.
3623             if (is<HTMLFormControlElement>(*oldFocusedElement)) {
3624                 HTMLFormControlElement& formControlElement = downcast<HTMLFormControlElement>(*oldFocusedElement);
3625                 if (formControlElement.wasChangedSinceLastFormControlChangeEvent())
3626                     formControlElement.dispatchFormControlChangeEvent();
3627             }
3628
3629             // Dispatch the blur event and let the node do any other blur related activities (important for text fields)
3630             oldFocusedElement->dispatchBlurEvent(newFocusedElement.copyRef());
3631
3632             if (m_focusedElement) {
3633                 // handler shifted focus
3634                 focusChangeBlocked = true;
3635                 newFocusedElement = nullptr;
3636             }
3637
3638             oldFocusedElement->dispatchFocusOutEvent(eventNames().focusoutEvent, newFocusedElement.copyRef()); // DOM level 3 name for the bubbling blur event.
3639             // FIXME: We should remove firing DOMFocusOutEvent event when we are sure no content depends
3640             // on it, probably when <rdar://problem/8503958> is resolved.
3641             oldFocusedElement->dispatchFocusOutEvent(eventNames().DOMFocusOutEvent, newFocusedElement.copyRef()); // DOM level 2 name for compatibility.
3642
3643             if (m_focusedElement) {
3644                 // handler shifted focus
3645