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