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