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