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