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