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