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