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