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