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