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