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