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