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