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