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