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