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