Mark more heap-allocated classes as fast allocated
[WebKit-https.git] / Source / WebCore / loader / FrameLoader.cpp
1 /*
2  * Copyright (C) 2006-2018 Apple Inc. All rights reserved.
3  * Copyright (C) 2008 Nokia Corporation and/or its subsidiary(-ies)
4  * Copyright (C) 2008, 2009 Torch Mobile Inc. All rights reserved. (http://www.torchmobile.com/)
5  * Copyright (C) 2008 Alp Toker <alp@atoker.com>
6  * Copyright (C) Research In Motion Limited 2009. All rights reserved.
7  * Copyright (C) 2011 Kris Jordan <krisjordan@gmail.com>
8  * Copyright (C) 2011 Google Inc. All rights reserved.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  *
14  * 1.  Redistributions of source code must retain the above copyright
15  *     notice, this list of conditions and the following disclaimer.
16  * 2.  Redistributions in binary form must reproduce the above copyright
17  *     notice, this list of conditions and the following disclaimer in the
18  *     documentation and/or other materials provided with the distribution.
19  * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
20  *     its contributors may be used to endorse or promote products derived
21  *     from this software without specific prior written permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
24  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
25  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
26  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
27  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
28  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
29  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
30  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
32  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33  */
34
35 #include "config.h"
36 #include "FrameLoader.h"
37
38 #include "AXObjectCache.h"
39 #include "ApplicationCacheHost.h"
40 #include "BackForwardController.h"
41 #include "BeforeUnloadEvent.h"
42 #include "CachedPage.h"
43 #include "CachedResourceLoader.h"
44 #include "Chrome.h"
45 #include "ChromeClient.h"
46 #include "CommonVM.h"
47 #include "ContentFilter.h"
48 #include "ContentSecurityPolicy.h"
49 #include "DOMWindow.h"
50 #include "DatabaseManager.h"
51 #include "DiagnosticLoggingClient.h"
52 #include "DiagnosticLoggingKeys.h"
53 #include "Document.h"
54 #include "DocumentLoader.h"
55 #include "Editor.h"
56 #include "EditorClient.h"
57 #include "Element.h"
58 #include "Event.h"
59 #include "EventHandler.h"
60 #include "EventNames.h"
61 #include "FloatRect.h"
62 #include "FormState.h"
63 #include "FormSubmission.h"
64 #include "Frame.h"
65 #include "FrameLoadRequest.h"
66 #include "FrameLoaderClient.h"
67 #include "FrameNetworkingContext.h"
68 #include "FrameTree.h"
69 #include "FrameView.h"
70 #include "GCController.h"
71 #include "HTMLFormElement.h"
72 #include "HTMLInputElement.h"
73 #include "HTMLNames.h"
74 #include "HTMLObjectElement.h"
75 #include "HTMLParserIdioms.h"
76 #include "HTTPHeaderNames.h"
77 #include "HTTPParsers.h"
78 #include "HistoryController.h"
79 #include "HistoryItem.h"
80 #include "IgnoreOpensDuringUnloadCountIncrementer.h"
81 #include "InspectorController.h"
82 #include "InspectorInstrumentation.h"
83 #include "LinkLoader.h"
84 #include "LoadTiming.h"
85 #include "LoaderStrategy.h"
86 #include "Logging.h"
87 #include "MemoryCache.h"
88 #include "MemoryRelease.h"
89 #include "NavigationDisabler.h"
90 #include "NavigationScheduler.h"
91 #include "Node.h"
92 #include "Page.h"
93 #include "PageCache.h"
94 #include "PageTransitionEvent.h"
95 #include "PerformanceLogging.h"
96 #include "PlatformStrategies.h"
97 #include "PluginData.h"
98 #include "PluginDocument.h"
99 #include "PolicyChecker.h"
100 #include "ProgressTracker.h"
101 #include "ResourceHandle.h"
102 #include "ResourceLoadInfo.h"
103 #include "ResourceLoadObserver.h"
104 #include "ResourceRequest.h"
105 #include "SVGDocument.h"
106 #include "SVGLocatable.h"
107 #include "SVGNames.h"
108 #include "SVGViewElement.h"
109 #include "SVGViewSpec.h"
110 #include "ScriptController.h"
111 #include "ScriptSourceCode.h"
112 #include "ScrollAnimator.h"
113 #include "SecurityOrigin.h"
114 #include "SecurityPolicy.h"
115 #include "SegmentedString.h"
116 #include "SerializedScriptValue.h"
117 #include "Settings.h"
118 #include "ShouldTreatAsContinuingLoad.h"
119 #include "SubframeLoader.h"
120 #include "SubresourceLoader.h"
121 #include "TextResourceDecoder.h"
122 #include "UserContentController.h"
123 #include "UserGestureIndicator.h"
124 #include "WindowFeatures.h"
125 #include "XMLDocumentParser.h"
126 #include <dom/ScriptDisallowedScope.h>
127 #include <wtf/CompletionHandler.h>
128 #include <wtf/URL.h>
129 #include <wtf/Ref.h>
130 #include <wtf/SetForScope.h>
131 #include <wtf/StdLibExtras.h>
132 #include <wtf/SystemTracing.h>
133 #include <wtf/text/CString.h>
134 #include <wtf/text/WTFString.h>
135
136 #if ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
137 #include "Archive.h"
138 #endif
139
140 #if ENABLE(DATA_DETECTION)
141 #include "DataDetection.h"
142 #endif
143
144 #if PLATFORM(IOS_FAMILY)
145 #include "DocumentType.h"
146 #include "ResourceLoader.h"
147 #include "RuntimeApplicationChecks.h"
148 #include "WKContentObservation.h"
149 #endif
150
151 #define RELEASE_LOG_IF_ALLOWED(fmt, ...) RELEASE_LOG_IF(isAlwaysOnLoggingAllowed(), Network, "%p - FrameLoader::" fmt, this, ##__VA_ARGS__)
152
153 namespace WebCore {
154
155 using namespace HTMLNames;
156 using namespace SVGNames;
157
158 static const char defaultAcceptHeader[] = "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8";
159
160 bool isBackForwardLoadType(FrameLoadType type)
161 {
162     switch (type) {
163     case FrameLoadType::Standard:
164     case FrameLoadType::Reload:
165     case FrameLoadType::ReloadFromOrigin:
166     case FrameLoadType::ReloadExpiredOnly:
167     case FrameLoadType::Same:
168     case FrameLoadType::RedirectWithLockedBackForwardList:
169     case FrameLoadType::Replace:
170         return false;
171     case FrameLoadType::Back:
172     case FrameLoadType::Forward:
173     case FrameLoadType::IndexedBackForward:
174         return true;
175     }
176     ASSERT_NOT_REACHED();
177     return false;
178 }
179
180 bool isReload(FrameLoadType type)
181 {
182     switch (type) {
183     case FrameLoadType::Reload:
184     case FrameLoadType::ReloadFromOrigin:
185     case FrameLoadType::ReloadExpiredOnly:
186         return true;
187     case FrameLoadType::Standard:
188     case FrameLoadType::Same:
189     case FrameLoadType::RedirectWithLockedBackForwardList:
190     case FrameLoadType::Replace:
191     case FrameLoadType::Back:
192     case FrameLoadType::Forward:
193     case FrameLoadType::IndexedBackForward:
194         return false;
195     }
196     ASSERT_NOT_REACHED();
197     return false;
198 }
199
200 // This is not in the FrameLoader class to emphasize that it does not depend on
201 // private FrameLoader data, and to avoid increasing the number of public functions
202 // with access to private data.  Since only this .cpp file needs it, making it
203 // non-member lets us exclude it from the header file, thus keeping FrameLoader.h's
204 // API simpler.
205 //
206 static bool isDocumentSandboxed(Frame& frame, SandboxFlags mask)
207 {
208     return frame.document() && frame.document()->isSandboxed(mask);
209 }
210
211 struct ForbidPromptsScope {
212     ForbidPromptsScope(Page* page) : m_page(page)
213     {
214         if (!m_page)
215             return;
216         m_page->forbidPrompts();
217     }
218
219     ~ForbidPromptsScope()
220     {
221         if (!m_page)
222             return;
223         m_page->allowPrompts();
224     }
225
226     Page* m_page;
227 };
228
229 class FrameLoader::FrameProgressTracker {
230     WTF_MAKE_FAST_ALLOCATED;
231 public:
232     explicit FrameProgressTracker(Frame& frame)
233         : m_frame(frame)
234         , m_inProgress(false)
235     {
236     }
237
238     ~FrameProgressTracker()
239     {
240         if (m_inProgress && m_frame.page())
241             m_frame.page()->progress().progressCompleted(m_frame);
242     }
243
244     void progressStarted()
245     {
246         ASSERT(m_frame.page());
247         if (!m_inProgress)
248             m_frame.page()->progress().progressStarted(m_frame);
249         m_inProgress = true;
250     }
251
252     void progressCompleted()
253     {
254         ASSERT(m_inProgress);
255         ASSERT(m_frame.page());
256         m_inProgress = false;
257         m_frame.page()->progress().progressCompleted(m_frame);
258
259         if (auto pageID = m_frame.loader().client().pageID())
260             platformStrategies()->loaderStrategy()->pageLoadCompleted(pageID.value());
261     }
262
263 private:
264     Frame& m_frame;
265     bool m_inProgress;
266 };
267
268 FrameLoader::FrameLoader(Frame& frame, FrameLoaderClient& client)
269     : m_frame(frame)
270     , m_client(client)
271     , m_policyChecker(std::make_unique<PolicyChecker>(frame))
272     , m_history(std::make_unique<HistoryController>(frame))
273     , m_notifier(frame)
274     , m_subframeLoader(std::make_unique<SubframeLoader>(frame))
275     , m_mixedContentChecker(frame)
276     , m_state(FrameStateProvisional)
277     , m_loadType(FrameLoadType::Standard)
278     , m_quickRedirectComing(false)
279     , m_sentRedirectNotification(false)
280     , m_inStopAllLoaders(false)
281     , m_isExecutingJavaScriptFormAction(false)
282     , m_didCallImplicitClose(true)
283     , m_wasUnloadEventEmitted(false)
284     , m_isComplete(false)
285     , m_needsClear(false)
286     , m_checkTimer(*this, &FrameLoader::checkTimerFired)
287     , m_shouldCallCheckCompleted(false)
288     , m_shouldCallCheckLoadComplete(false)
289     , m_opener(nullptr)
290     , m_loadingFromCachedPage(false)
291     , m_currentNavigationHasShownBeforeUnloadConfirmPanel(false)
292     , m_loadsSynchronously(false)
293     , m_forcedSandboxFlags(SandboxNone)
294 {
295 }
296
297 FrameLoader::~FrameLoader()
298 {
299     setOpener(nullptr);
300
301     for (auto& frame : m_openedFrames)
302         frame->loader().m_opener = nullptr;
303
304     m_client.frameLoaderDestroyed();
305
306     if (m_networkingContext)
307         m_networkingContext->invalidate();
308 }
309
310 void FrameLoader::init()
311 {
312     // This somewhat odd set of steps gives the frame an initial empty document.
313     setPolicyDocumentLoader(m_client.createDocumentLoader(ResourceRequest(URL({ }, emptyString())), SubstituteData()).ptr());
314     setProvisionalDocumentLoader(m_policyDocumentLoader.get());
315     m_provisionalDocumentLoader->startLoadingMainResource();
316
317     Ref<Frame> protect(m_frame);
318     m_frame.document()->cancelParsing();
319     m_stateMachine.advanceTo(FrameLoaderStateMachine::DisplayingInitialEmptyDocument);
320
321     m_networkingContext = m_client.createNetworkingContext();
322     m_progressTracker = std::make_unique<FrameProgressTracker>(m_frame);
323 }
324
325 void FrameLoader::initForSynthesizedDocument(const URL&)
326 {
327     // FIXME: We need to initialize the document URL to the specified URL. Currently the URL is empty and hence
328     // FrameLoader::checkCompleted() will overwrite the URL of the document to be activeDocumentLoader()->documentURL().
329
330     auto loader = m_client.createDocumentLoader(ResourceRequest(URL({ }, emptyString())), SubstituteData());
331     loader->attachToFrame(m_frame);
332     loader->setResponse(ResourceResponse(URL(), "text/html"_s, 0, String()));
333     loader->setCommitted(true);
334     setDocumentLoader(loader.ptr());
335
336     m_stateMachine.advanceTo(FrameLoaderStateMachine::DisplayingInitialEmptyDocument);
337     m_stateMachine.advanceTo(FrameLoaderStateMachine::DisplayingInitialEmptyDocumentPostCommit);
338     m_stateMachine.advanceTo(FrameLoaderStateMachine::CommittedFirstRealLoad);
339     m_client.transitionToCommittedForNewPage();
340
341     m_didCallImplicitClose = true;
342     m_isComplete = true;
343     m_state = FrameStateComplete;
344     m_needsClear = true;
345
346     m_networkingContext = m_client.createNetworkingContext();
347     m_progressTracker = std::make_unique<FrameProgressTracker>(m_frame);
348 }
349
350 void FrameLoader::setDefersLoading(bool defers)
351 {
352     if (m_documentLoader)
353         m_documentLoader->setDefersLoading(defers);
354     if (m_provisionalDocumentLoader)
355         m_provisionalDocumentLoader->setDefersLoading(defers);
356     if (m_policyDocumentLoader)
357         m_policyDocumentLoader->setDefersLoading(defers);
358     history().setDefersLoading(defers);
359
360     if (!defers) {
361         m_frame.navigationScheduler().startTimer();
362         startCheckCompleteTimer();
363     }
364 }
365
366 void FrameLoader::checkContentPolicy(const ResourceResponse& response, PolicyCheckIdentifier identifier, ContentPolicyDecisionFunction&& function)
367 {
368     if (!activeDocumentLoader()) {
369         // Load was cancelled
370         function(PolicyAction::Ignore, identifier);
371         return;
372     }
373
374     // FIXME: Validate the policy check identifier.
375     client().dispatchDecidePolicyForResponse(response, activeDocumentLoader()->request(), identifier, WTFMove(function));
376 }
377
378 void FrameLoader::changeLocation(FrameLoadRequest&& request)
379 {
380     urlSelected(WTFMove(request), nullptr);
381 }
382
383 void FrameLoader::urlSelected(const URL& url, const String& passedTarget, Event* triggeringEvent, LockHistory lockHistory, LockBackForwardList lockBackForwardList, ShouldSendReferrer shouldSendReferrer, ShouldOpenExternalURLsPolicy shouldOpenExternalURLsPolicy, Optional<NewFrameOpenerPolicy> openerPolicy, const AtomicString& downloadAttribute, const SystemPreviewInfo& systemPreviewInfo, Optional<AdClickAttribution>&& adClickAttribution)
384 {
385     auto* frame = lexicalFrameFromCommonVM();
386     auto initiatedByMainFrame = frame && frame->isMainFrame() ? InitiatedByMainFrame::Yes : InitiatedByMainFrame::Unknown;
387
388     NewFrameOpenerPolicy newFrameOpenerPolicy = openerPolicy.valueOr(shouldSendReferrer == NeverSendReferrer ? NewFrameOpenerPolicy::Suppress : NewFrameOpenerPolicy::Allow);
389     urlSelected(FrameLoadRequest(*m_frame.document(), m_frame.document()->securityOrigin(), { url }, passedTarget, lockHistory, lockBackForwardList, shouldSendReferrer, AllowNavigationToInvalidURL::Yes, newFrameOpenerPolicy, shouldOpenExternalURLsPolicy, initiatedByMainFrame, DoNotReplaceDocumentIfJavaScriptURL, downloadAttribute, systemPreviewInfo), triggeringEvent, WTFMove(adClickAttribution));
390 }
391
392 void FrameLoader::urlSelected(FrameLoadRequest&& frameRequest, Event* triggeringEvent, Optional<AdClickAttribution>&& adClickAttribution)
393 {
394     RELEASE_LOG_IF_ALLOWED("urlSelected: frame load started (frame = %p, main = %d)", &m_frame, m_frame.isMainFrame());
395
396     Ref<Frame> protect(m_frame);
397
398     if (m_frame.script().executeIfJavaScriptURL(frameRequest.resourceRequest().url(), frameRequest.shouldReplaceDocumentIfJavaScriptURL()))
399         return;
400
401     if (frameRequest.frameName().isEmpty())
402         frameRequest.setFrameName(m_frame.document()->baseTarget());
403
404     addHTTPOriginIfNeeded(frameRequest.resourceRequest(), outgoingOrigin());
405     m_frame.document()->contentSecurityPolicy()->upgradeInsecureRequestIfNeeded(frameRequest.resourceRequest(), ContentSecurityPolicy::InsecureRequestType::Navigation);
406
407     loadFrameRequest(WTFMove(frameRequest), triggeringEvent, { }, WTFMove(adClickAttribution));
408 }
409
410 void FrameLoader::submitForm(Ref<FormSubmission>&& submission)
411 {
412     ASSERT(submission->method() == FormSubmission::Method::Post || submission->method() == FormSubmission::Method::Get);
413
414     // FIXME: Find a good spot for these.
415     ASSERT(!submission->state().sourceDocument().frame() || submission->state().sourceDocument().frame() == &m_frame);
416
417     if (!m_frame.page())
418         return;
419
420     if (submission->action().isEmpty())
421         return;
422
423     if (isDocumentSandboxed(m_frame, SandboxForms)) {
424         // FIXME: This message should be moved off the console once a solution to https://bugs.webkit.org/show_bug.cgi?id=103274 exists.
425         m_frame.document()->addConsoleMessage(MessageSource::Security, MessageLevel::Error, "Blocked form submission to '" + submission->action().stringCenterEllipsizedToLength() + "' because the form's frame is sandboxed and the 'allow-forms' permission is not set.");
426         return;
427     }
428
429     if (WTF::protocolIsJavaScript(submission->action())) {
430         if (!m_frame.document()->contentSecurityPolicy()->allowFormAction(URL(submission->action())))
431             return;
432         m_isExecutingJavaScriptFormAction = true;
433         Ref<Frame> protect(m_frame);
434         m_frame.script().executeIfJavaScriptURL(submission->action(), DoNotReplaceDocumentIfJavaScriptURL);
435         m_isExecutingJavaScriptFormAction = false;
436         return;
437     }
438
439     Frame* targetFrame = findFrameForNavigation(submission->target(), &submission->state().sourceDocument());
440     if (!targetFrame) {
441         if (!DOMWindow::allowPopUp(m_frame) && !UserGestureIndicator::processingUserGesture())
442             return;
443
444         // FIXME: targetFrame can be null for two distinct reasons:
445         // 1. The frame was not found by name, so we should try opening a new window.
446         // 2. The frame was found, but navigating it was not allowed, e.g. by HTML5 sandbox or by origin checks.
447         // Continuing form submission makes no sense in the latter case.
448         // There is a repeat check after timer fires, so this is not a correctness issue.
449
450         targetFrame = &m_frame;
451     } else
452         submission->clearTarget();
453
454     if (!targetFrame->page())
455         return;
456
457     // FIXME: We'd like to remove this altogether and fix the multiple form submission issue another way.
458
459     // We do not want to submit more than one form from the same page, nor do we want to submit a single
460     // form more than once. This flag prevents these from happening; not sure how other browsers prevent this.
461     // The flag is reset in each time we start dispatching a new mouse or key down event, and
462     // also in setView since this part may get reused for a page from the back/forward cache.
463     // The form multi-submit logic here is only needed when we are submitting a form that affects this frame.
464
465     // FIXME: Frame targeting is only one of the ways the submission could end up doing something other
466     // than replacing this frame's content, so this check is flawed. On the other hand, the check is hardly
467     // needed any more now that we reset m_submittedFormURL on each mouse or key down event.
468
469     if (m_frame.tree().isDescendantOf(targetFrame)) {
470         if (m_submittedFormURL == submission->requestURL())
471             return;
472         m_submittedFormURL = submission->requestURL();
473     }
474
475     submission->data().generateFiles(m_frame.document());
476     submission->setReferrer(outgoingReferrer());
477     submission->setOrigin(outgoingOrigin());
478
479     targetFrame->navigationScheduler().scheduleFormSubmission(WTFMove(submission));
480 }
481
482 void FrameLoader::stopLoading(UnloadEventPolicy unloadEventPolicy)
483 {
484     if (m_frame.document() && m_frame.document()->parser())
485         m_frame.document()->parser()->stopParsing();
486
487     if (unloadEventPolicy != UnloadEventPolicyNone)
488         dispatchUnloadEvents(unloadEventPolicy);
489
490     m_isComplete = true; // to avoid calling completed() in finishedParsing()
491     m_didCallImplicitClose = true; // don't want that one either
492
493     if (m_frame.document() && m_frame.document()->parsing()) {
494         finishedParsing();
495         m_frame.document()->setParsing(false);
496     }
497
498     if (auto* document = m_frame.document()) {
499         // FIXME: HTML5 doesn't tell us to set the state to complete when aborting, but we do anyway to match legacy behavior.
500         // http://www.w3.org/Bugs/Public/show_bug.cgi?id=10537
501         document->setReadyState(Document::Complete);
502
503         // FIXME: Should the DatabaseManager watch for something like ActiveDOMObject::stop() rather than being special-cased here?
504         DatabaseManager::singleton().stopDatabases(*document, nullptr);
505     }
506
507     policyChecker().stopCheck();
508
509     // FIXME: This will cancel redirection timer, which really needs to be restarted when restoring the frame from b/f cache.
510     m_frame.navigationScheduler().cancel();
511 }
512
513 void FrameLoader::stop()
514 {
515     // http://bugs.webkit.org/show_bug.cgi?id=10854
516     // The frame's last ref may be removed and it will be deleted by checkCompleted().
517     Ref<Frame> protect(m_frame);
518
519     if (DocumentParser* parser = m_frame.document()->parser()) {
520         parser->stopParsing();
521         parser->finish();
522     }
523 }
524
525 void FrameLoader::willTransitionToCommitted()
526 {
527     // This function is called when a frame is still fully in place (not cached, not detached), but will be replaced.
528
529     if (m_frame.editor().hasComposition()) {
530         // The text was already present in DOM, so it's better to confirm than to cancel the composition.
531         m_frame.editor().confirmComposition();
532         if (EditorClient* editorClient = m_frame.editor().client()) {
533             editorClient->respondToChangedSelection(&m_frame);
534             editorClient->discardedComposition(&m_frame);
535         }
536     }
537 }
538
539 bool FrameLoader::closeURL()
540 {
541     history().saveDocumentState();
542
543     Document* currentDocument = m_frame.document();
544     UnloadEventPolicy unloadEventPolicy;
545     if (m_frame.page() && m_frame.page()->chrome().client().isSVGImageChromeClient()) {
546         // If this is the SVGDocument of an SVGImage, no need to dispatch events or recalcStyle.
547         unloadEventPolicy = UnloadEventPolicyNone;
548     } else {
549         // Should only send the pagehide event here if the current document exists and has not been placed in the page cache.
550         unloadEventPolicy = currentDocument && currentDocument->pageCacheState() == Document::NotInPageCache ? UnloadEventPolicyUnloadAndPageHide : UnloadEventPolicyUnloadOnly;
551     }
552
553     stopLoading(unloadEventPolicy);
554     
555     m_frame.editor().clearUndoRedoOperations();
556     return true;
557 }
558
559 bool FrameLoader::didOpenURL()
560 {
561     if (m_frame.navigationScheduler().redirectScheduledDuringLoad()) {
562         // A redirect was scheduled before the document was created.
563         // This can happen when one frame changes another frame's location.
564         return false;
565     }
566
567     m_frame.navigationScheduler().cancel();
568     m_frame.editor().clearLastEditCommand();
569
570     m_isComplete = false;
571     m_didCallImplicitClose = false;
572
573     // If we are still in the process of initializing an empty document then
574     // its frame is not in a consistent state for rendering, so avoid setJSStatusBarText
575     // since it may cause clients to attempt to render the frame.
576     if (!m_stateMachine.creatingInitialEmptyDocument()) {
577         DOMWindow* window = m_frame.document()->domWindow();
578         window->setStatus(String());
579         window->setDefaultStatus(String());
580     }
581
582     started();
583
584     return true;
585 }
586
587 void FrameLoader::didExplicitOpen()
588 {
589     m_isComplete = false;
590     m_didCallImplicitClose = false;
591
592     // Calling document.open counts as committing the first real document load.
593     if (!m_stateMachine.committedFirstRealDocumentLoad())
594         m_stateMachine.advanceTo(FrameLoaderStateMachine::DisplayingInitialEmptyDocumentPostCommit);
595     
596     // Prevent window.open(url) -- eg window.open("about:blank") -- from blowing away results
597     // from a subsequent window.document.open / window.document.write call. 
598     // Canceling redirection here works for all cases because document.open 
599     // implicitly precedes document.write.
600     m_frame.navigationScheduler().cancel();
601 }
602
603
604 void FrameLoader::cancelAndClear()
605 {
606     m_frame.navigationScheduler().cancel();
607
608     if (!m_isComplete)
609         closeURL();
610
611     clear(m_frame.document(), false);
612     m_frame.script().updatePlatformScriptObjects();
613 }
614
615 static inline bool shouldClearWindowName(const Frame& frame, const Document& newDocument)
616 {
617     if (!frame.isMainFrame())
618         return false;
619
620     if (frame.loader().opener())
621         return false;
622
623     return !newDocument.securityOrigin().isSameOriginAs(frame.document()->securityOrigin());
624 }
625
626 void FrameLoader::clear(Document* newDocument, bool clearWindowProperties, bool clearScriptObjects, bool clearFrameView)
627 {
628     m_frame.editor().clear();
629
630     if (!m_needsClear)
631         return;
632     m_needsClear = false;
633     
634     if (m_frame.document()->pageCacheState() != Document::InPageCache) {
635         m_frame.document()->cancelParsing();
636         m_frame.document()->stopActiveDOMObjects();
637         bool hadLivingRenderTree = m_frame.document()->hasLivingRenderTree();
638         m_frame.document()->prepareForDestruction();
639         if (hadLivingRenderTree)
640             m_frame.document()->adjustFocusedNodeOnNodeRemoval(*m_frame.document());
641     }
642
643     // Do this after detaching the document so that the unload event works.
644     if (clearWindowProperties) {
645         InspectorInstrumentation::frameWindowDiscarded(m_frame, m_frame.document()->domWindow());
646         m_frame.document()->domWindow()->resetUnlessSuspendedForDocumentSuspension();
647         m_frame.windowProxy().clearJSWindowProxiesNotMatchingDOMWindow(newDocument->domWindow(), m_frame.document()->pageCacheState() == Document::AboutToEnterPageCache);
648
649         if (shouldClearWindowName(m_frame, *newDocument))
650             m_frame.tree().setName(nullAtom());
651     }
652
653     m_frame.selection().prepareForDestruction();
654     m_frame.eventHandler().clear();
655
656     if (clearFrameView && m_frame.view())
657         m_frame.view()->clear();
658
659     // Do not drop the document before the ScriptController and view are cleared
660     // as some destructors might still try to access the document.
661     m_frame.setDocument(nullptr);
662
663     subframeLoader().clear();
664
665     if (clearWindowProperties)
666         m_frame.windowProxy().setDOMWindow(newDocument->domWindow());
667
668     if (clearScriptObjects)
669         m_frame.script().clearScriptObjects();
670
671     m_frame.script().enableEval();
672
673     m_frame.navigationScheduler().clear();
674
675     m_checkTimer.stop();
676     m_shouldCallCheckCompleted = false;
677     m_shouldCallCheckLoadComplete = false;
678
679     if (m_stateMachine.isDisplayingInitialEmptyDocument() && m_stateMachine.committedFirstRealDocumentLoad())
680         m_stateMachine.advanceTo(FrameLoaderStateMachine::CommittedFirstRealLoad);
681 }
682
683 void FrameLoader::receivedFirstData()
684 {
685     dispatchDidCommitLoad(WTF::nullopt);
686     dispatchDidClearWindowObjectsInAllWorlds();
687     dispatchGlobalObjectAvailableInAllWorlds();
688
689     if (!m_documentLoader)
690         return;
691
692     auto& documentLoader = *m_documentLoader;
693     auto& title = documentLoader.title();
694     if (!title.string.isNull())
695         m_client.dispatchDidReceiveTitle(title);
696
697     ASSERT(m_frame.document());
698     auto& document = *m_frame.document();
699
700     LinkLoader::loadLinksFromHeader(documentLoader.response().httpHeaderField(HTTPHeaderName::Link), document.url(), document, LinkLoader::MediaAttributeCheck::MediaAttributeEmpty);
701
702     double delay;
703     String urlString;
704     if (!parseHTTPRefresh(documentLoader.response().httpHeaderField(HTTPHeaderName::Refresh), delay, urlString))
705         return;
706     auto completedURL = urlString.isEmpty() ? document.url() : document.completeURL(urlString);
707     if (!WTF::protocolIsJavaScript(completedURL))
708         m_frame.navigationScheduler().scheduleRedirect(document, delay, completedURL);
709     else {
710         auto message = "Refused to refresh " + document.url().stringCenterEllipsizedToLength() + " to a javascript: URL";
711         document.addConsoleMessage(MessageSource::Security, MessageLevel::Error, message);
712     }
713 }
714
715 void FrameLoader::setOutgoingReferrer(const URL& url)
716 {
717     m_outgoingReferrer = url.strippedForUseAsReferrer();
718 }
719
720 void FrameLoader::didBeginDocument(bool dispatch)
721 {
722     m_needsClear = true;
723     m_isComplete = false;
724     m_didCallImplicitClose = false;
725     m_frame.document()->setReadyState(Document::Loading);
726
727     if (m_pendingStateObject) {
728         m_frame.document()->statePopped(*m_pendingStateObject);
729         m_pendingStateObject = nullptr;
730     }
731
732     if (dispatch)
733         dispatchDidClearWindowObjectsInAllWorlds();
734
735     updateFirstPartyForCookies();
736     m_frame.document()->initContentSecurityPolicy();
737
738     const Settings& settings = m_frame.settings();
739     m_frame.document()->cachedResourceLoader().setImagesEnabled(settings.areImagesEnabled());
740     m_frame.document()->cachedResourceLoader().setAutoLoadImages(settings.loadsImagesAutomatically());
741
742     if (m_documentLoader) {
743         String dnsPrefetchControl = m_documentLoader->response().httpHeaderField(HTTPHeaderName::XDNSPrefetchControl);
744         if (!dnsPrefetchControl.isEmpty())
745             m_frame.document()->parseDNSPrefetchControlHeader(dnsPrefetchControl);
746
747         m_frame.document()->contentSecurityPolicy()->didReceiveHeaders(ContentSecurityPolicyResponseHeaders(m_documentLoader->response()), referrer(), ContentSecurityPolicy::ReportParsingErrors::No);
748
749         String referrerPolicy = m_documentLoader->response().httpHeaderField(HTTPHeaderName::ReferrerPolicy);
750         if (!referrerPolicy.isNull())
751             m_frame.document()->processReferrerPolicy(referrerPolicy, ReferrerPolicySource::HTTPHeader);
752
753         String headerContentLanguage = m_documentLoader->response().httpHeaderField(HTTPHeaderName::ContentLanguage);
754         if (!headerContentLanguage.isEmpty()) {
755             size_t commaIndex = headerContentLanguage.find(',');
756             headerContentLanguage.truncate(commaIndex); // notFound == -1 == don't truncate
757             headerContentLanguage = stripLeadingAndTrailingHTMLSpaces(headerContentLanguage);
758             if (!headerContentLanguage.isEmpty())
759                 m_frame.document()->setContentLanguage(headerContentLanguage);
760         }
761     }
762
763     history().restoreDocumentState();
764 }
765
766 void FrameLoader::finishedParsing()
767 {
768     LOG(Loading, "WebCoreLoading %s: Finished parsing", m_frame.tree().uniqueName().string().utf8().data());
769
770     m_frame.injectUserScripts(InjectAtDocumentEnd);
771
772     if (m_stateMachine.creatingInitialEmptyDocument())
773         return;
774
775     // This can be called from the Frame's destructor, in which case we shouldn't protect ourselves
776     // because doing so will cause us to re-enter the destructor when protector goes out of scope.
777     // Null-checking the FrameView indicates whether or not we're in the destructor.
778     RefPtr<Frame> protector = m_frame.view() ? &m_frame : 0;
779
780     m_client.dispatchDidFinishDocumentLoad();
781
782     scrollToFragmentWithParentBoundary(m_frame.document()->url());
783
784     checkCompleted();
785
786     if (!m_frame.view())
787         return; // We are being destroyed by something checkCompleted called.
788
789     // Check if the scrollbars are really needed for the content.
790     // If not, remove them, relayout, and repaint.
791     m_frame.view()->restoreScrollbar();
792 }
793
794 void FrameLoader::loadDone(LoadCompletionType type)
795 {
796     if (type == LoadCompletionType::Finish)
797         checkCompleted();
798     else
799         scheduleCheckCompleted();
800 }
801
802 void FrameLoader::subresourceLoadDone(LoadCompletionType type)
803 {
804     if (type == LoadCompletionType::Finish)
805         checkLoadComplete();
806     else
807         scheduleCheckLoadComplete();
808 }
809
810 bool FrameLoader::allChildrenAreComplete() const
811 {
812     for (Frame* child = m_frame.tree().firstChild(); child; child = child->tree().nextSibling()) {
813         if (!child->loader().m_isComplete)
814             return false;
815     }
816     return true;
817 }
818
819 bool FrameLoader::allAncestorsAreComplete() const
820 {
821     for (Frame* ancestor = &m_frame; ancestor; ancestor = ancestor->tree().parent()) {
822         if (!ancestor->loader().m_isComplete)
823             return false;
824     }
825     return true;
826 }
827
828 void FrameLoader::checkCompleted()
829 {
830     RELEASE_ASSERT_WITH_SECURITY_IMPLICATION(ScriptDisallowedScope::InMainThread::isScriptAllowed());
831     m_shouldCallCheckCompleted = false;
832
833     // Have we completed before?
834     if (m_isComplete)
835         return;
836     
837 #if ENABLE(VIDEO)
838     // FIXME: Remove this code once https://webkit.org/b/185284 is fixed.
839     if (HTMLMediaElement::isRunningDestructor()) {
840         ASSERT_NOT_REACHED();
841         scheduleCheckCompleted();
842         return;
843     }
844 #endif
845
846     // FIXME: It would be better if resource loads were kicked off after render tree update (or didn't complete synchronously).
847     //        https://bugs.webkit.org/show_bug.cgi?id=171729
848     if (m_frame.document()->inRenderTreeUpdate()) {
849         scheduleCheckCompleted();
850         return;
851     }
852
853     // Are we still parsing?
854     if (m_frame.document()->parsing())
855         return;
856
857     // Still waiting for images/scripts?
858     if (m_frame.document()->cachedResourceLoader().requestCount())
859         return;
860
861     // Still waiting for elements that don't go through a FrameLoader?
862     if (m_frame.document()->isDelayingLoadEvent())
863         return;
864
865     auto* scriptableParser = m_frame.document()->scriptableDocumentParser();
866     if (scriptableParser && scriptableParser->hasScriptsWaitingForStylesheets())
867         return;
868
869     // Any frame that hasn't completed yet?
870     if (!allChildrenAreComplete())
871         return;
872
873     // Important not to protect earlier in this function, because earlier parts
874     // of this function can be called in the frame's destructor, and it's not legal
875     // to ref an object while it's being destroyed.
876     Ref<Frame> protect(m_frame);
877
878     // OK, completed.
879     m_isComplete = true;
880     m_requestedHistoryItem = nullptr;
881     m_frame.document()->setReadyState(Document::Complete);
882
883 #if PLATFORM(IOS_FAMILY)
884     if (m_frame.document()->url().isEmpty()) {
885         // We need to update the document URL of a PDF document to be non-empty so that both back/forward history navigation
886         // between PDF pages and fragment navigation works. See <rdar://problem/9544769> for more details.
887         // FIXME: Is there a better place for this code, say DocumentLoader? Also, we should explicitly only update the URL
888         // of the document when it's a PDFDocument object instead of assuming that a Document object with an empty URL is a PDFDocument.
889         // FIXME: This code is incorrect for a synthesized document (which also has an empty URL). The URL for a synthesized
890         // document should be the URL specified to FrameLoader::initForSynthesizedDocument().
891         m_frame.document()->setURL(activeDocumentLoader()->documentURL());
892     }
893 #endif
894
895     checkCallImplicitClose(); // if we didn't do it before
896
897     m_frame.navigationScheduler().startTimer();
898
899     completed();
900     if (m_frame.page())
901         checkLoadComplete();
902 }
903
904 void FrameLoader::checkTimerFired()
905 {
906     checkCompletenessNow();
907 }
908
909 void FrameLoader::checkCompletenessNow()
910 {
911     Ref<Frame> protect(m_frame);
912
913     if (Page* page = m_frame.page()) {
914         if (page->defersLoading())
915             return;
916     }
917     if (m_shouldCallCheckCompleted)
918         checkCompleted();
919     if (m_shouldCallCheckLoadComplete)
920         checkLoadComplete();
921 }
922
923 void FrameLoader::startCheckCompleteTimer()
924 {
925     if (!(m_shouldCallCheckCompleted || m_shouldCallCheckLoadComplete))
926         return;
927     if (m_checkTimer.isActive())
928         return;
929     m_checkTimer.startOneShot(0_s);
930 }
931
932 void FrameLoader::scheduleCheckCompleted()
933 {
934     m_shouldCallCheckCompleted = true;
935     startCheckCompleteTimer();
936 }
937
938 void FrameLoader::scheduleCheckLoadComplete()
939 {
940     m_shouldCallCheckLoadComplete = true;
941     startCheckCompleteTimer();
942 }
943
944 void FrameLoader::checkCallImplicitClose()
945 {
946     if (m_didCallImplicitClose || m_frame.document()->parsing() || m_frame.document()->isDelayingLoadEvent())
947         return;
948
949     if (!allChildrenAreComplete())
950         return; // still got a frame running -> too early
951
952     m_didCallImplicitClose = true;
953     m_wasUnloadEventEmitted = false;
954     m_frame.document()->implicitClose();
955 }
956
957 void FrameLoader::loadURLIntoChildFrame(const URL& url, const String& referer, Frame* childFrame)
958 {
959     RELEASE_LOG_IF_ALLOWED("loadURLIntoChildFrame: frame load started (frame = %p, main = %d)", &m_frame, m_frame.isMainFrame());
960
961     ASSERT(childFrame);
962
963 #if ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
964     if (auto activeLoader = activeDocumentLoader()) {
965         if (auto subframeArchive = activeLoader->popArchiveForSubframe(childFrame->tree().uniqueName(), url)) {
966             childFrame->loader().loadArchive(RefPtr<Archive> { subframeArchive }.releaseNonNull());
967             return;
968         }
969     }
970 #endif
971
972     // If we're moving in the back/forward list, we might want to replace the content
973     // of this child frame with whatever was there at that point.
974     auto* parentItem = history().currentItem();
975     if (parentItem && parentItem->children().size() && isBackForwardLoadType(loadType()) && !m_frame.document()->loadEventFinished()) {
976         if (auto* childItem = parentItem->childItemWithTarget(childFrame->tree().uniqueName())) {
977             childFrame->loader().m_requestedHistoryItem = childItem;
978             childFrame->loader().loadDifferentDocumentItem(*childItem, loadType(), MayAttemptCacheOnlyLoadForFormSubmissionItem, ShouldTreatAsContinuingLoad::No);
979             return;
980         }
981     }
982
983     auto* lexicalFrame = lexicalFrameFromCommonVM();
984     auto initiatedByMainFrame = lexicalFrame && lexicalFrame->isMainFrame() ? InitiatedByMainFrame::Yes : InitiatedByMainFrame::Unknown;
985
986     FrameLoadRequest frameLoadRequest { *m_frame.document(), m_frame.document()->securityOrigin(), { url }, "_self"_s, LockHistory::No, LockBackForwardList::Yes, ShouldSendReferrer::MaybeSendReferrer, AllowNavigationToInvalidURL::Yes, NewFrameOpenerPolicy::Suppress, ShouldOpenExternalURLsPolicy::ShouldNotAllow, initiatedByMainFrame };
987     childFrame->loader().loadURL(WTFMove(frameLoadRequest), referer, FrameLoadType::RedirectWithLockedBackForwardList, nullptr, { }, WTF::nullopt, [] { });
988 }
989
990 #if ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
991
992 void FrameLoader::loadArchive(Ref<Archive>&& archive)
993 {
994     RELEASE_LOG_IF_ALLOWED("loadArchive: frame load started (frame = %p, main = %d)", &m_frame, m_frame.isMainFrame());
995
996     ArchiveResource* mainResource = archive->mainResource();
997     ASSERT(mainResource);
998     if (!mainResource)
999         return;
1000
1001     ResourceResponse response(URL(), mainResource->mimeType(), mainResource->data().size(), mainResource->textEncoding());
1002     SubstituteData substituteData(&mainResource->data(), URL(), response, SubstituteData::SessionHistoryVisibility::Hidden);
1003     
1004     ResourceRequest request(mainResource->url());
1005
1006     auto documentLoader = m_client.createDocumentLoader(request, substituteData);
1007     documentLoader->setArchive(WTFMove(archive));
1008     load(documentLoader.get());
1009 }
1010
1011 #endif // ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
1012
1013 String FrameLoader::outgoingReferrer() const
1014 {
1015     // See http://www.whatwg.org/specs/web-apps/current-work/#fetching-resources
1016     // for why we walk the parent chain for srcdoc documents.
1017     Frame* frame = &m_frame;
1018     while (frame && frame->document()->isSrcdocDocument()) {
1019         frame = frame->tree().parent();
1020         // Srcdoc documents cannot be top-level documents, by definition,
1021         // because they need to be contained in iframes with the srcdoc.
1022         ASSERT(frame);
1023     }
1024     if (!frame)
1025         return emptyString();
1026     return frame->loader().m_outgoingReferrer;
1027 }
1028
1029 String FrameLoader::outgoingOrigin() const
1030 {
1031     return m_frame.document()->securityOrigin().toString();
1032 }
1033
1034 bool FrameLoader::checkIfFormActionAllowedByCSP(const URL& url, bool didReceiveRedirectResponse) const
1035 {
1036     if (m_submittedFormURL.isEmpty())
1037         return true;
1038
1039     auto redirectResponseReceived = didReceiveRedirectResponse ? ContentSecurityPolicy::RedirectResponseReceived::Yes : ContentSecurityPolicy::RedirectResponseReceived::No;
1040     return m_frame.document()->contentSecurityPolicy()->allowFormAction(url, redirectResponseReceived);
1041 }
1042
1043 Frame* FrameLoader::opener()
1044 {
1045     return m_opener;
1046 }
1047
1048 void FrameLoader::setOpener(Frame* opener)
1049 {
1050     if (m_opener && !opener)
1051         m_client.didDisownOpener();
1052
1053     if (m_opener) {
1054         // When setOpener is called in ~FrameLoader, opener's m_frameLoader is already cleared.
1055         auto& openerFrameLoader = m_opener == &m_frame ? *this : m_opener->loader();
1056         openerFrameLoader.m_openedFrames.remove(&m_frame);
1057     }
1058     if (opener) {
1059         opener->loader().m_openedFrames.add(&m_frame);
1060         if (auto* page = m_frame.page())
1061             page->setOpenedByDOMWithOpener();
1062     }
1063     m_opener = opener;
1064
1065     if (m_frame.document())
1066         m_frame.document()->initSecurityContext();
1067 }
1068
1069 // FIXME: This does not belong in FrameLoader!
1070 void FrameLoader::handleFallbackContent()
1071 {
1072     HTMLFrameOwnerElement* owner = m_frame.ownerElement();
1073     if (!is<HTMLObjectElement>(owner))
1074         return;
1075     downcast<HTMLObjectElement>(*owner).renderFallbackContent();
1076 }
1077
1078 void FrameLoader::provisionalLoadStarted()
1079 {
1080     if (m_stateMachine.firstLayoutDone())
1081         m_stateMachine.advanceTo(FrameLoaderStateMachine::CommittedFirstRealLoad);
1082     m_frame.navigationScheduler().cancel(NewLoadInProgress::Yes);
1083     m_client.provisionalLoadStarted();
1084
1085     if (m_frame.isMainFrame()) {
1086         tracePoint(MainResourceLoadDidStartProvisional);
1087
1088         if (auto* page = m_frame.page())
1089             page->didStartProvisionalLoad();
1090     }
1091 }
1092
1093 void FrameLoader::resetMultipleFormSubmissionProtection()
1094 {
1095     m_submittedFormURL = URL();
1096 }
1097
1098 void FrameLoader::updateFirstPartyForCookies()
1099 {
1100     if (m_frame.tree().parent())
1101         setFirstPartyForCookies(m_frame.tree().parent()->document()->firstPartyForCookies());
1102     else
1103         setFirstPartyForCookies(m_frame.document()->url());
1104 }
1105
1106 void FrameLoader::setFirstPartyForCookies(const URL& url)
1107 {
1108     for (Frame* frame = &m_frame; frame; frame = frame->tree().traverseNext(&m_frame))
1109         frame->document()->setFirstPartyForCookies(url);
1110
1111     String registrableDomain = ResourceRequest::partitionName(url.host().toString());
1112     for (Frame* frame = &m_frame; frame; frame = frame->tree().traverseNext(&m_frame)) {
1113         if (SecurityPolicy::shouldInheritSecurityOriginFromOwner(frame->document()->url()) || registrableDomainsAreEqual(frame->document()->url(), registrableDomain))
1114             frame->document()->setSiteForCookies(url);
1115     }
1116 }
1117
1118 // This does the same kind of work that didOpenURL does, except it relies on the fact
1119 // that a higher level already checked that the URLs match and the scrolling is the right thing to do.
1120 void FrameLoader::loadInSameDocument(const URL& url, SerializedScriptValue* stateObject, bool isNewNavigation)
1121 {
1122     RELEASE_LOG_IF_ALLOWED("loadInSameDocument: frame load started (frame = %p, main = %d)", &m_frame, m_frame.isMainFrame());
1123
1124     // If we have a state object, we cannot also be a new navigation.
1125     ASSERT(!stateObject || (stateObject && !isNewNavigation));
1126
1127     // Update the data source's request with the new URL to fake the URL change
1128     URL oldURL = m_frame.document()->url();
1129     m_frame.document()->setURL(url);
1130     setOutgoingReferrer(url);
1131     documentLoader()->replaceRequestURLForSameDocumentNavigation(url);
1132     if (isNewNavigation && !shouldTreatURLAsSameAsCurrent(url) && !stateObject) {
1133         // NB: must happen after replaceRequestURLForSameDocumentNavigation(), since we add 
1134         // based on the current request. Must also happen before we openURL and displace the 
1135         // scroll position, since adding the BF item will save away scroll state.
1136         
1137         // NB2: If we were loading a long, slow doc, and the user fragment navigated before
1138         // it was done, currItem is now set the that slow doc, and prevItem is whatever was
1139         // before it.  Adding the b/f item will bump the slow doc down to prevItem, even
1140         // though its load is not yet done.  I think this all works out OK, for one because
1141         // we have already saved away the scroll and doc state for the long slow load,
1142         // but it's not an obvious case.
1143
1144         history().updateBackForwardListForFragmentScroll();
1145     }
1146     
1147     bool hashChange = equalIgnoringFragmentIdentifier(url, oldURL) && url.fragmentIdentifier() != oldURL.fragmentIdentifier();
1148     
1149     history().updateForSameDocumentNavigation();
1150
1151     // If we were in the autoscroll/panScroll mode we want to stop it before following the link to the anchor
1152     if (hashChange)
1153         m_frame.eventHandler().stopAutoscrollTimer();
1154     
1155     // It's important to model this as a load that starts and immediately finishes.
1156     // Otherwise, the parent frame may think we never finished loading.
1157     started();
1158
1159     if (auto* ownerElement = m_frame.ownerElement()) {
1160         auto* ownerRenderer = ownerElement->renderer();
1161         auto* view = m_frame.view();
1162         if (is<RenderWidget>(ownerRenderer) && view)
1163             downcast<RenderWidget>(*ownerRenderer).setWidget(view);
1164     }
1165
1166     // We need to scroll to the fragment whether or not a hash change occurred, since
1167     // the user might have scrolled since the previous navigation.
1168     scrollToFragmentWithParentBoundary(url, isNewNavigation);
1169     
1170     m_isComplete = false;
1171     checkCompleted();
1172
1173     if (isNewNavigation) {
1174         // This will clear previousItem from the rest of the frame tree that didn't
1175         // doing any loading. We need to make a pass on this now, since for fragment
1176         // navigation we'll not go through a real load and reach Completed state.
1177         checkLoadComplete();
1178     }
1179
1180     m_client.dispatchDidNavigateWithinPage();
1181
1182     m_frame.document()->statePopped(stateObject ? Ref<SerializedScriptValue> { *stateObject } : SerializedScriptValue::nullValue());
1183     m_client.dispatchDidPopStateWithinPage();
1184     
1185     if (hashChange) {
1186         m_frame.document()->enqueueHashchangeEvent(oldURL, url);
1187         m_client.dispatchDidChangeLocationWithinPage();
1188     }
1189     
1190     // FrameLoaderClient::didFinishLoad() tells the internal load delegate the load finished with no error
1191     m_client.didFinishLoad();
1192 }
1193
1194 bool FrameLoader::isComplete() const
1195 {
1196     return m_isComplete;
1197 }
1198
1199 void FrameLoader::completed()
1200 {
1201     Ref<Frame> protect(m_frame);
1202
1203     for (Frame* descendant = m_frame.tree().traverseNext(&m_frame); descendant; descendant = descendant->tree().traverseNext(&m_frame))
1204         descendant->navigationScheduler().startTimer();
1205
1206     if (Frame* parent = m_frame.tree().parent())
1207         parent->loader().checkCompleted();
1208
1209     if (m_frame.view())
1210         m_frame.view()->maintainScrollPositionAtAnchor(nullptr);
1211 }
1212
1213 void FrameLoader::started()
1214 {
1215     for (Frame* frame = &m_frame; frame; frame = frame->tree().parent())
1216         frame->loader().m_isComplete = false;
1217 }
1218
1219 void FrameLoader::prepareForLoadStart()
1220 {
1221     RELEASE_LOG_IF_ALLOWED("prepareForLoadStart: Starting frame load (frame = %p, main = %d)", &m_frame, m_frame.isMainFrame());
1222
1223     m_progressTracker->progressStarted();
1224     m_client.dispatchDidStartProvisionalLoad();
1225
1226     if (AXObjectCache::accessibilityEnabled()) {
1227         if (AXObjectCache* cache = m_frame.document()->existingAXObjectCache()) {
1228             AXObjectCache::AXLoadingEvent loadingEvent = loadType() == FrameLoadType::Reload ? AXObjectCache::AXLoadingReloaded : AXObjectCache::AXLoadingStarted;
1229             cache->frameLoadingEventNotification(&m_frame, loadingEvent);
1230         }
1231     }
1232 }
1233
1234 void FrameLoader::setupForReplace()
1235 {
1236     m_client.revertToProvisionalState(m_documentLoader.get());
1237     setState(FrameStateProvisional);
1238     m_provisionalDocumentLoader = m_documentLoader;
1239     m_documentLoader = nullptr;
1240     detachChildren();
1241 }
1242
1243 void FrameLoader::loadFrameRequest(FrameLoadRequest&& request, Event* event, RefPtr<FormState>&& formState, Optional<AdClickAttribution>&& adClickAttribution)
1244 {
1245     RELEASE_LOG_IF_ALLOWED("loadFrameRequest: frame load started (frame = %p, main = %d)", &m_frame, m_frame.isMainFrame());
1246
1247     // Protect frame from getting blown away inside dispatchBeforeLoadEvent in loadWithDocumentLoader.
1248     auto protectFrame = makeRef(m_frame);
1249
1250     URL url = request.resourceRequest().url();
1251
1252     ASSERT(m_frame.document());
1253     if (!request.requesterSecurityOrigin().canDisplay(url)) {
1254         reportLocalLoadFailed(&m_frame, url.stringCenterEllipsizedToLength());
1255         return;
1256     }
1257
1258     String argsReferrer = request.resourceRequest().httpReferrer();
1259     if (argsReferrer.isEmpty())
1260         argsReferrer = outgoingReferrer();
1261
1262     String referrer = SecurityPolicy::generateReferrerHeader(m_frame.document()->referrerPolicy(), url, argsReferrer);
1263     if (request.shouldSendReferrer() == NeverSendReferrer)
1264         referrer = String();
1265
1266     FrameLoadType loadType;
1267     if (request.resourceRequest().cachePolicy() == ResourceRequestCachePolicy::ReloadIgnoringCacheData)
1268         loadType = FrameLoadType::Reload;
1269     else if (request.lockBackForwardList() == LockBackForwardList::Yes)
1270         loadType = FrameLoadType::RedirectWithLockedBackForwardList;
1271     else
1272         loadType = FrameLoadType::Standard;
1273
1274     auto completionHandler = [this, protectedFrame = makeRef(m_frame), formState = makeWeakPtr(formState.get()), frameName = request.frameName()] {
1275         // FIXME: It's possible this targetFrame will not be the same frame that was targeted by the actual
1276         // load if frame names have changed.
1277         Frame* sourceFrame = formState ? formState->sourceDocument().frame() : &m_frame;
1278         if (!sourceFrame)
1279             sourceFrame = &m_frame;
1280         Frame* targetFrame = sourceFrame->loader().findFrameForNavigation(frameName);
1281         if (targetFrame && targetFrame != sourceFrame) {
1282             if (Page* page = targetFrame->page())
1283                 page->chrome().focus();
1284         }
1285     };
1286
1287     if (request.resourceRequest().httpMethod() == "POST")
1288         loadPostRequest(WTFMove(request), referrer, loadType, event, WTFMove(formState), WTFMove(completionHandler));
1289     else
1290         loadURL(WTFMove(request), referrer, loadType, event, WTFMove(formState), WTFMove(adClickAttribution), WTFMove(completionHandler));
1291 }
1292
1293 static ShouldOpenExternalURLsPolicy shouldOpenExternalURLsPolicyToApply(Frame& currentFrame, InitiatedByMainFrame initiatedByMainFrame, ShouldOpenExternalURLsPolicy propagatedPolicy)
1294 {
1295     if (UserGestureIndicator::processingUserGesture())
1296         return ShouldOpenExternalURLsPolicy::ShouldAllow;
1297
1298     if (initiatedByMainFrame == InitiatedByMainFrame::Yes)
1299         return propagatedPolicy;
1300
1301     if (!currentFrame.isMainFrame())
1302         return ShouldOpenExternalURLsPolicy::ShouldNotAllow;
1303
1304     return propagatedPolicy;
1305 }
1306
1307 static ShouldOpenExternalURLsPolicy shouldOpenExternalURLsPolicyToApply(Frame& currentFrame, const FrameLoadRequest& frameLoadRequest)
1308 {
1309     return shouldOpenExternalURLsPolicyToApply(currentFrame, frameLoadRequest.initiatedByMainFrame(), frameLoadRequest.shouldOpenExternalURLsPolicy());
1310 }
1311
1312 static void applyShouldOpenExternalURLsPolicyToNewDocumentLoader(Frame& frame, DocumentLoader& documentLoader, InitiatedByMainFrame initiatedByMainFrame, ShouldOpenExternalURLsPolicy propagatedPolicy)
1313 {
1314     documentLoader.setShouldOpenExternalURLsPolicy(shouldOpenExternalURLsPolicyToApply(frame, initiatedByMainFrame, propagatedPolicy));
1315 }
1316
1317 static void applyShouldOpenExternalURLsPolicyToNewDocumentLoader(Frame& frame, DocumentLoader& documentLoader, const FrameLoadRequest& frameLoadRequest)
1318 {
1319     documentLoader.setShouldOpenExternalURLsPolicy(shouldOpenExternalURLsPolicyToApply(frame, frameLoadRequest));
1320 }
1321
1322 bool FrameLoader::isNavigationAllowed() const
1323 {
1324     return m_pageDismissalEventBeingDispatched == PageDismissalType::None && NavigationDisabler::isNavigationAllowed(m_frame);
1325 }
1326
1327 bool FrameLoader::isStopLoadingAllowed() const
1328 {
1329     return m_pageDismissalEventBeingDispatched == PageDismissalType::None;
1330 }
1331
1332 void FrameLoader::loadURL(FrameLoadRequest&& frameLoadRequest, const String& referrer, FrameLoadType newLoadType, Event* event, RefPtr<FormState>&& formState, Optional<AdClickAttribution>&& adClickAttribution, CompletionHandler<void()>&& completionHandler)
1333 {
1334     RELEASE_LOG_IF_ALLOWED("loadURL: frame load started (frame = %p, main = %d)", &m_frame, m_frame.isMainFrame());
1335
1336     CompletionHandlerCallingScope completionHandlerCaller(WTFMove(completionHandler));
1337     if (m_inStopAllLoaders || m_inClearProvisionalLoadForPolicyCheck)
1338         return;
1339
1340     Ref<Frame> protect(m_frame);
1341
1342     // Anchor target is ignored when the download attribute is set since it will download the hyperlink rather than follow it.
1343     String effectiveFrameName = frameLoadRequest.downloadAttribute().isNull() ? frameLoadRequest.frameName() : String();
1344     AllowNavigationToInvalidURL allowNavigationToInvalidURL = frameLoadRequest.allowNavigationToInvalidURL();
1345     NewFrameOpenerPolicy openerPolicy = frameLoadRequest.newFrameOpenerPolicy();
1346     LockHistory lockHistory = frameLoadRequest.lockHistory();
1347     bool isFormSubmission = formState;
1348
1349     const URL& newURL = frameLoadRequest.resourceRequest().url();
1350     ResourceRequest request(newURL);
1351     if (!referrer.isEmpty()) {
1352         request.setHTTPReferrer(referrer);
1353         auto referrerOrigin = SecurityOrigin::createFromString(referrer);
1354         addHTTPOriginIfNeeded(request, referrerOrigin->toString());
1355     }
1356     if (&m_frame.tree().top() != &m_frame)
1357         request.setDomainForCachePartition(m_frame.tree().top().document()->domainForCachePartition());
1358
1359     addExtraFieldsToRequest(request, newLoadType, true);
1360     if (isReload(newLoadType))
1361         request.setCachePolicy(ResourceRequestCachePolicy::ReloadIgnoringCacheData);
1362
1363     ASSERT(newLoadType != FrameLoadType::Same);
1364
1365     // The search for a target frame is done earlier in the case of form submission.
1366     Frame* targetFrame = isFormSubmission ? nullptr : findFrameForNavigation(effectiveFrameName);
1367     if (targetFrame && targetFrame != &m_frame) {
1368         frameLoadRequest.setFrameName("_self");
1369         targetFrame->loader().loadURL(WTFMove(frameLoadRequest), referrer, newLoadType, event, WTFMove(formState), WTFMove(adClickAttribution), completionHandlerCaller.release());
1370         return;
1371     }
1372
1373     if (!isNavigationAllowed())
1374         return;
1375
1376     NavigationAction action { frameLoadRequest.requester(), request, frameLoadRequest.initiatedByMainFrame(), newLoadType, isFormSubmission, event, frameLoadRequest.shouldOpenExternalURLsPolicy(), frameLoadRequest.downloadAttribute() };
1377     action.setLockHistory(lockHistory);
1378     action.setLockBackForwardList(frameLoadRequest.lockBackForwardList());
1379     if (adClickAttribution && m_frame.isMainFrame())
1380         action.setAdClickAttribution(WTFMove(*adClickAttribution));
1381
1382     if (!targetFrame && !effectiveFrameName.isEmpty()) {
1383         action = action.copyWithShouldOpenExternalURLsPolicy(shouldOpenExternalURLsPolicyToApply(m_frame, frameLoadRequest));
1384         policyChecker().setLoadType(newLoadType);
1385         RELEASE_ASSERT(!isBackForwardLoadType(policyChecker().loadType()));
1386         policyChecker().checkNewWindowPolicy(WTFMove(action), WTFMove(request), WTFMove(formState), effectiveFrameName, [this, allowNavigationToInvalidURL, openerPolicy, completionHandler = completionHandlerCaller.release()] (const ResourceRequest& request, WeakPtr<FormState>&& formState, const String& frameName, const NavigationAction& action, ShouldContinue shouldContinue) mutable {
1387             continueLoadAfterNewWindowPolicy(request, formState.get(), frameName, action, shouldContinue, allowNavigationToInvalidURL, openerPolicy);
1388             completionHandler();
1389         });
1390         return;
1391     }
1392
1393     RefPtr<DocumentLoader> oldDocumentLoader = m_documentLoader;
1394
1395     bool sameURL = shouldTreatURLAsSameAsCurrent(newURL);
1396     const String& httpMethod = request.httpMethod();
1397     
1398     // Make sure to do scroll to fragment processing even if the URL is
1399     // exactly the same so pages with '#' links and DHTML side effects
1400     // work properly.
1401     if (shouldPerformFragmentNavigation(isFormSubmission, httpMethod, newLoadType, newURL)) {
1402         oldDocumentLoader->setTriggeringAction(WTFMove(action));
1403         oldDocumentLoader->setLastCheckedRequest(ResourceRequest());
1404         policyChecker().stopCheck();
1405         policyChecker().setLoadType(newLoadType);
1406         RELEASE_ASSERT(!isBackForwardLoadType(newLoadType) || history().provisionalItem());
1407         policyChecker().checkNavigationPolicy(WTFMove(request), ResourceResponse { } /* redirectResponse */, oldDocumentLoader.get(), WTFMove(formState), [this, protectedFrame = makeRef(m_frame)] (const ResourceRequest& request, WeakPtr<FormState>&&, NavigationPolicyDecision navigationPolicyDecision) {
1408             continueFragmentScrollAfterNavigationPolicy(request, navigationPolicyDecision == NavigationPolicyDecision::ContinueLoad);
1409         }, PolicyDecisionMode::Synchronous);
1410         return;
1411     }
1412
1413     // Must grab this now, since this load may stop the previous load and clear this flag.
1414     bool isRedirect = m_quickRedirectComing;
1415 #if USE(SYSTEM_PREVIEW)
1416     bool isSystemPreview = frameLoadRequest.isSystemPreview();
1417     request.setSystemPreview(isSystemPreview);
1418     if (isSystemPreview)
1419         request.setSystemPreviewRect(frameLoadRequest.systemPreviewRect());
1420 #endif
1421     loadWithNavigationAction(request, WTFMove(action), lockHistory, newLoadType, WTFMove(formState), allowNavigationToInvalidURL, [this, isRedirect, sameURL, newLoadType, protectedFrame = makeRef(m_frame), completionHandler = completionHandlerCaller.release()] () mutable {
1422         if (isRedirect) {
1423             m_quickRedirectComing = false;
1424             if (m_provisionalDocumentLoader)
1425                 m_provisionalDocumentLoader->setIsClientRedirect(true);
1426             else if (m_policyDocumentLoader)
1427                 m_policyDocumentLoader->setIsClientRedirect(true);
1428         } else if (sameURL && !isReload(newLoadType)) {
1429             // Example of this case are sites that reload the same URL with a different cookie
1430             // driving the generated content, or a master frame with links that drive a target
1431             // frame, where the user has clicked on the same link repeatedly.
1432             m_loadType = FrameLoadType::Same;
1433         }
1434         completionHandler();
1435     });
1436 }
1437
1438 SubstituteData FrameLoader::defaultSubstituteDataForURL(const URL& url)
1439 {
1440     if (!shouldTreatURLAsSrcdocDocument(url))
1441         return SubstituteData();
1442     auto& srcdoc = m_frame.ownerElement()->attributeWithoutSynchronization(srcdocAttr);
1443     ASSERT(!srcdoc.isNull());
1444     CString encodedSrcdoc = srcdoc.string().utf8();
1445
1446     ResourceResponse response(URL(), "text/html"_s, encodedSrcdoc.length(), "UTF-8"_s);
1447     return SubstituteData(SharedBuffer::create(encodedSrcdoc.data(), encodedSrcdoc.length()), URL(), response, SubstituteData::SessionHistoryVisibility::Hidden);
1448 }
1449
1450 void FrameLoader::load(FrameLoadRequest&& request)
1451 {
1452     RELEASE_LOG_IF_ALLOWED("load (FrameLoadRequest): frame load started (frame = %p, main = %d)", &m_frame, m_frame.isMainFrame());
1453
1454     if (m_inStopAllLoaders || m_inClearProvisionalLoadForPolicyCheck)
1455         return;
1456
1457     if (!request.frameName().isEmpty()) {
1458         Frame* frame = findFrameForNavigation(request.frameName());
1459         if (frame) {
1460             request.setShouldCheckNewWindowPolicy(false);
1461             if (&frame->loader() != this) {
1462                 frame->loader().load(WTFMove(request));
1463                 return;
1464             }
1465         }
1466     }
1467
1468     if (request.shouldCheckNewWindowPolicy()) {
1469         NavigationAction action { request.requester(), request.resourceRequest(), InitiatedByMainFrame::Unknown, NavigationType::Other, request.shouldOpenExternalURLsPolicy() };
1470         RELEASE_ASSERT(!isBackForwardLoadType(policyChecker().loadType()));
1471         policyChecker().checkNewWindowPolicy(WTFMove(action), WTFMove(request.resourceRequest()), { }, request.frameName(), [this] (const ResourceRequest& request, WeakPtr<FormState>&& formState, const String& frameName, const NavigationAction& action, ShouldContinue shouldContinue) {
1472             continueLoadAfterNewWindowPolicy(request, formState.get(), frameName, action, shouldContinue, AllowNavigationToInvalidURL::Yes, NewFrameOpenerPolicy::Suppress);
1473         });
1474
1475         return;
1476     }
1477
1478     if (!request.hasSubstituteData())
1479         request.setSubstituteData(defaultSubstituteDataForURL(request.resourceRequest().url()));
1480
1481     Ref<DocumentLoader> loader = m_client.createDocumentLoader(request.resourceRequest(), request.substituteData());
1482     addSameSiteInfoToRequestIfNeeded(loader->request());
1483     applyShouldOpenExternalURLsPolicyToNewDocumentLoader(m_frame, loader, request);
1484
1485     if (request.shouldTreatAsContinuingLoad()) {
1486         loader->setClientRedirectSourceForHistory(request.clientRedirectSourceForHistory());
1487         if (request.lockBackForwardList() == LockBackForwardList::Yes) {
1488             loader->setIsClientRedirect(true);
1489             m_loadType = FrameLoadType::RedirectWithLockedBackForwardList;
1490         }
1491     }
1492
1493     SetForScope<LoadContinuingState> continuingLoadGuard(m_currentLoadContinuingState, request.shouldTreatAsContinuingLoad() ? LoadContinuingState::ContinuingWithRequest : LoadContinuingState::NotContinuing);
1494     load(loader.get());
1495 }
1496
1497 void FrameLoader::loadWithNavigationAction(const ResourceRequest& request, NavigationAction&& action, LockHistory lockHistory, FrameLoadType type, RefPtr<FormState>&& formState, AllowNavigationToInvalidURL allowNavigationToInvalidURL, CompletionHandler<void()>&& completionHandler)
1498 {
1499     RELEASE_LOG_IF_ALLOWED("loadWithNavigationAction: frame load started (frame = %p, main = %d)", &m_frame, m_frame.isMainFrame());
1500
1501     Ref<DocumentLoader> loader = m_client.createDocumentLoader(request, defaultSubstituteDataForURL(request.url()));
1502     applyShouldOpenExternalURLsPolicyToNewDocumentLoader(m_frame, loader, action.initiatedByMainFrame(), action.shouldOpenExternalURLsPolicy());
1503
1504     if (lockHistory == LockHistory::Yes && m_documentLoader)
1505         loader->setClientRedirectSourceForHistory(m_documentLoader->didCreateGlobalHistoryEntry() ? m_documentLoader->urlForHistory().string() : m_documentLoader->clientRedirectSourceForHistory());
1506
1507     loader->setTriggeringAction(WTFMove(action));
1508     if (m_documentLoader)
1509         loader->setOverrideEncoding(m_documentLoader->overrideEncoding());
1510
1511     loadWithDocumentLoader(loader.ptr(), type, WTFMove(formState), allowNavigationToInvalidURL, ShouldTreatAsContinuingLoad::No, WTFMove(completionHandler));
1512 }
1513
1514 void FrameLoader::load(DocumentLoader& newDocumentLoader)
1515 {
1516     RELEASE_LOG_IF_ALLOWED("load (DocumentLoader): frame load started (frame = %p, main = %d)", &m_frame, m_frame.isMainFrame());
1517
1518     ResourceRequest& r = newDocumentLoader.request();
1519     addExtraFieldsToMainResourceRequest(r);
1520     FrameLoadType type;
1521
1522     if (shouldTreatURLAsSameAsCurrent(newDocumentLoader.originalRequest().url())) {
1523         r.setCachePolicy(ResourceRequestCachePolicy::ReloadIgnoringCacheData);
1524         type = FrameLoadType::Same;
1525     } else if (shouldTreatURLAsSameAsCurrent(newDocumentLoader.unreachableURL()) && isReload(m_loadType))
1526         type = m_loadType;
1527     else if (m_loadType == FrameLoadType::RedirectWithLockedBackForwardList && ((!newDocumentLoader.unreachableURL().isEmpty() && newDocumentLoader.substituteData().isValid()) || shouldTreatCurrentLoadAsContinuingLoad()))
1528         type = FrameLoadType::RedirectWithLockedBackForwardList;
1529     else
1530         type = FrameLoadType::Standard;
1531
1532     if (m_documentLoader)
1533         newDocumentLoader.setOverrideEncoding(m_documentLoader->overrideEncoding());
1534     
1535     // When we loading alternate content for an unreachable URL that we're
1536     // visiting in the history list, we treat it as a reload so the history list 
1537     // is appropriately maintained.
1538     //
1539     // FIXME: This seems like a dangerous overloading of the meaning of "FrameLoadType::Reload" ...
1540     // shouldn't a more explicit type of reload be defined, that means roughly 
1541     // "load without affecting history" ? 
1542     if (shouldReloadToHandleUnreachableURL(newDocumentLoader)) {
1543         // shouldReloadToHandleUnreachableURL returns true only when the original load type is back-forward.
1544         // In this case we should save the document state now. Otherwise the state can be lost because load type is
1545         // changed and updateForBackForwardNavigation() will not be called when loading is committed.
1546         history().saveDocumentAndScrollState();
1547
1548         ASSERT(type == FrameLoadType::Standard);
1549         type = FrameLoadType::Reload;
1550     }
1551
1552     loadWithDocumentLoader(&newDocumentLoader, type, nullptr, AllowNavigationToInvalidURL::Yes, ShouldTreatAsContinuingLoad::No);
1553 }
1554
1555 void FrameLoader::loadWithDocumentLoader(DocumentLoader* loader, FrameLoadType type, RefPtr<FormState>&& formState, AllowNavigationToInvalidURL allowNavigationToInvalidURL, ShouldTreatAsContinuingLoad, CompletionHandler<void()>&& completionHandler)
1556 {
1557     RELEASE_LOG_IF_ALLOWED("loadWithDocumentLoader: frame load started (frame = %p, main = %d)", &m_frame, m_frame.isMainFrame());
1558
1559     // Retain because dispatchBeforeLoadEvent may release the last reference to it.
1560     Ref<Frame> protect(m_frame);
1561
1562     CompletionHandlerCallingScope completionHandlerCaller(WTFMove(completionHandler));
1563
1564     ASSERT(m_client.hasWebView());
1565
1566     // Unfortunately the view must be non-nil, this is ultimately due
1567     // to parser requiring a FrameView.  We should fix this dependency.
1568
1569     ASSERT(m_frame.view());
1570
1571     if (!isNavigationAllowed())
1572         return;
1573
1574     if (m_frame.document())
1575         m_previousURL = m_frame.document()->url();
1576
1577     const URL& newURL = loader->request().url();
1578
1579     // Only the first iframe navigation or the first iframe navigation after about:blank should be reported.
1580     // https://www.w3.org/TR/resource-timing-2/#resources-included-in-the-performanceresourcetiming-interface
1581     if (m_shouldReportResourceTimingToParentFrame && !m_previousURL.isNull() && m_previousURL != WTF::blankURL())
1582         m_shouldReportResourceTimingToParentFrame = false;
1583
1584     // Log main frame navigation types.
1585     if (m_frame.isMainFrame()) {
1586         if (auto* page = m_frame.page()) {
1587             RELEASE_LOG_IF_ALLOWED("loadWithDocumentLoader: main frame load started (frame = %p, main = %d)", &m_frame, m_frame.isMainFrame());
1588             page->mainFrameLoadStarted(newURL, type);
1589             page->performanceLogging().didReachPointOfInterest(PerformanceLogging::MainFrameLoadStarted);
1590         }
1591     }
1592
1593     policyChecker().setLoadType(type);
1594     RELEASE_ASSERT(!isBackForwardLoadType(type) || history().provisionalItem());
1595     bool isFormSubmission = formState;
1596
1597     const String& httpMethod = loader->request().httpMethod();
1598
1599     if (shouldPerformFragmentNavigation(isFormSubmission, httpMethod, policyChecker().loadType(), newURL)) {
1600         RefPtr<DocumentLoader> oldDocumentLoader = m_documentLoader;
1601         NavigationAction action { *m_frame.document(), loader->request(), InitiatedByMainFrame::Unknown, policyChecker().loadType(), isFormSubmission };
1602
1603         oldDocumentLoader->setTriggeringAction(WTFMove(action));
1604         oldDocumentLoader->setLastCheckedRequest(ResourceRequest());
1605         policyChecker().stopCheck();
1606         RELEASE_ASSERT(!isBackForwardLoadType(policyChecker().loadType()) || history().provisionalItem());
1607         policyChecker().checkNavigationPolicy(ResourceRequest(loader->request()), ResourceResponse { }  /* redirectResponse */, oldDocumentLoader.get(), WTFMove(formState), [this, protectedFrame = makeRef(m_frame)] (const ResourceRequest& request, WeakPtr<FormState>&&, NavigationPolicyDecision navigationPolicyDecision) {
1608             continueFragmentScrollAfterNavigationPolicy(request, navigationPolicyDecision == NavigationPolicyDecision::ContinueLoad);
1609         }, PolicyDecisionMode::Synchronous);
1610         return;
1611     }
1612
1613     if (Frame* parent = m_frame.tree().parent())
1614         loader->setOverrideEncoding(parent->loader().documentLoader()->overrideEncoding());
1615
1616     policyChecker().stopCheck();
1617     setPolicyDocumentLoader(loader);
1618     if (loader->triggeringAction().isEmpty())
1619         loader->setTriggeringAction({ *m_frame.document(), loader->request(), InitiatedByMainFrame::Unknown, policyChecker().loadType(), isFormSubmission });
1620
1621     if (Element* ownerElement = m_frame.ownerElement()) {
1622         // We skip dispatching the beforeload event if we've already
1623         // committed a real document load because the event would leak
1624         // subsequent activity by the frame which the parent frame isn't
1625         // supposed to learn. For example, if the child frame navigated to
1626         // a new URL, the parent frame shouldn't learn the URL.
1627         if (!m_stateMachine.committedFirstRealDocumentLoad()
1628             && !ownerElement->dispatchBeforeLoadEvent(loader->request().url().string())) {
1629             continueLoadAfterNavigationPolicy(loader->request(), formState.get(), NavigationPolicyDecision::IgnoreLoad, allowNavigationToInvalidURL);
1630             return;
1631         }
1632     }
1633
1634     m_frame.navigationScheduler().cancel(NewLoadInProgress::Yes);
1635
1636     if (shouldTreatCurrentLoadAsContinuingLoad()) {
1637         continueLoadAfterNavigationPolicy(loader->request(), formState.get(), NavigationPolicyDecision::ContinueLoad, allowNavigationToInvalidURL);
1638         return;
1639     }
1640
1641     RELEASE_ASSERT(!isBackForwardLoadType(policyChecker().loadType()) || history().provisionalItem());
1642     policyChecker().checkNavigationPolicy(ResourceRequest(loader->request()), ResourceResponse { } /* redirectResponse */, loader, WTFMove(formState), [this, protectedFrame = makeRef(m_frame), allowNavigationToInvalidURL, completionHandler = completionHandlerCaller.release()] (const ResourceRequest& request, WeakPtr<FormState>&& formState, NavigationPolicyDecision navigationPolicyDecision) mutable {
1643         continueLoadAfterNavigationPolicy(request, formState.get(), navigationPolicyDecision, allowNavigationToInvalidURL);
1644         completionHandler();
1645     }, PolicyDecisionMode::Asynchronous);
1646 }
1647
1648 void FrameLoader::clearProvisionalLoadForPolicyCheck()
1649 {
1650     if (!m_policyDocumentLoader || !m_provisionalDocumentLoader || m_inClearProvisionalLoadForPolicyCheck)
1651         return;
1652
1653     SetForScope<bool> change(m_inClearProvisionalLoadForPolicyCheck, true);
1654     m_provisionalDocumentLoader->stopLoading();
1655     setProvisionalDocumentLoader(nullptr);
1656 }
1657
1658 void FrameLoader::reportLocalLoadFailed(Frame* frame, const String& url)
1659 {
1660     ASSERT(!url.isEmpty());
1661     if (!frame)
1662         return;
1663
1664     frame->document()->addConsoleMessage(MessageSource::Security, MessageLevel::Error, "Not allowed to load local resource: " + url);
1665 }
1666
1667 void FrameLoader::reportBlockedPortFailed(Frame* frame, const String& url)
1668 {
1669     ASSERT(!url.isEmpty());
1670     if (!frame)
1671         return;
1672     
1673     frame->document()->addConsoleMessage(MessageSource::Security, MessageLevel::Error, "Not allowed to use restricted network port: " + url);
1674 }
1675
1676 void FrameLoader::reportAuthenticationChallengeBlocked(Frame* frame, const URL& url, const String& reason)
1677 {
1678     if (!frame)
1679         return;
1680
1681     frame->document()->addConsoleMessage(MessageSource::Security, MessageLevel::Error, makeString("Blocked ", url.stringCenterEllipsizedToLength(), " from asking for credentials because ", reason, '.'));
1682 }
1683
1684 const ResourceRequest& FrameLoader::initialRequest() const
1685 {
1686     return activeDocumentLoader()->originalRequest();
1687 }
1688
1689 bool FrameLoader::willLoadMediaElementURL(URL& url, Node& initiatorNode)
1690 {
1691 #if PLATFORM(IOS_FAMILY)
1692     // MobileStore depends on the iOS 4.0 era client delegate method because webView:resource:willSendRequest:redirectResponse:fromDataSource
1693     // doesn't let them tell when a load request is coming from a media element. See <rdar://problem/8266916> for more details.
1694     if (IOSApplication::isMobileStore())
1695         return m_client.shouldLoadMediaElementURL(url);
1696 #endif
1697
1698     ResourceRequest request(url);
1699     request.setInspectorInitiatorNodeIdentifier(InspectorInstrumentation::identifierForNode(initiatorNode));
1700
1701     unsigned long identifier;
1702     ResourceError error;
1703     requestFromDelegate(request, identifier, error);
1704     notifier().sendRemainingDelegateMessages(m_documentLoader.get(), identifier, request, ResourceResponse(url, String(), -1, String()), 0, -1, -1, error);
1705
1706     url = request.url();
1707
1708     return error.isNull();
1709 }
1710
1711 bool FrameLoader::shouldReloadToHandleUnreachableURL(DocumentLoader& docLoader)
1712 {
1713     URL unreachableURL = docLoader.unreachableURL();
1714
1715     if (unreachableURL.isEmpty())
1716         return false;
1717
1718     if (!isBackForwardLoadType(policyChecker().loadType()))
1719         return false;
1720
1721     // We only treat unreachableURLs specially during the delegate callbacks
1722     // for provisional load errors and navigation policy decisions. The former
1723     // case handles well-formed URLs that can't be loaded, and the latter
1724     // case handles malformed URLs and unknown schemes. Loading alternate content
1725     // at other times behaves like a standard load.
1726     if (policyChecker().delegateIsDecidingNavigationPolicy() || policyChecker().delegateIsHandlingUnimplementablePolicy())
1727         return m_policyDocumentLoader && unreachableURL == m_policyDocumentLoader->request().url();
1728
1729     return unreachableURL == m_provisionalLoadErrorBeingHandledURL;
1730 }
1731
1732 void FrameLoader::reloadWithOverrideEncoding(const String& encoding)
1733 {
1734     if (!m_documentLoader)
1735         return;
1736
1737     RELEASE_LOG_IF_ALLOWED("reloadWithOverrideEncoding: frame load started (frame = %p, main = %d)", &m_frame, m_frame.isMainFrame());
1738
1739     ResourceRequest request = m_documentLoader->request();
1740     URL unreachableURL = m_documentLoader->unreachableURL();
1741     if (!unreachableURL.isEmpty())
1742         request.setURL(unreachableURL);
1743
1744     // FIXME: If the resource is a result of form submission and is not cached, the form will be silently resubmitted.
1745     // We should ask the user for confirmation in this case.
1746     request.setCachePolicy(ResourceRequestCachePolicy::ReturnCacheDataElseLoad);
1747
1748     Ref<DocumentLoader> loader = m_client.createDocumentLoader(request, defaultSubstituteDataForURL(request.url()));
1749     applyShouldOpenExternalURLsPolicyToNewDocumentLoader(m_frame, loader, InitiatedByMainFrame::Unknown, m_documentLoader->shouldOpenExternalURLsPolicyToPropagate());
1750
1751     setPolicyDocumentLoader(loader.ptr());
1752
1753     loader->setOverrideEncoding(encoding);
1754
1755     loadWithDocumentLoader(loader.ptr(), FrameLoadType::Reload, { }, AllowNavigationToInvalidURL::Yes, ShouldTreatAsContinuingLoad::No);
1756 }
1757
1758 void FrameLoader::reload(OptionSet<ReloadOption> options)
1759 {
1760     if (!m_documentLoader)
1761         return;
1762
1763     // If a window is created by javascript, its main frame can have an empty but non-nil URL.
1764     // Reloading in this case will lose the current contents (see 4151001).
1765     if (m_documentLoader->request().url().isEmpty())
1766         return;
1767
1768     RELEASE_LOG_IF_ALLOWED("reload: frame load started (frame = %p, main = %d)", &m_frame, m_frame.isMainFrame());
1769
1770     // Replace error-page URL with the URL we were trying to reach.
1771     ResourceRequest initialRequest = m_documentLoader->request();
1772     URL unreachableURL = m_documentLoader->unreachableURL();
1773     if (!unreachableURL.isEmpty())
1774         initialRequest.setURL(unreachableURL);
1775
1776     // Create a new document loader for the reload, this will become m_documentLoader eventually,
1777     // but first it has to be the "policy" document loader, and then the "provisional" document loader.
1778     Ref<DocumentLoader> loader = m_client.createDocumentLoader(initialRequest, defaultSubstituteDataForURL(initialRequest.url()));
1779     applyShouldOpenExternalURLsPolicyToNewDocumentLoader(m_frame, loader, InitiatedByMainFrame::Unknown, m_documentLoader->shouldOpenExternalURLsPolicyToPropagate());
1780
1781     loader->setUserContentExtensionsEnabled(!options.contains(ReloadOption::DisableContentBlockers));
1782     
1783     ResourceRequest& request = loader->request();
1784
1785     // FIXME: We don't have a mechanism to revalidate the main resource without reloading at the moment.
1786     request.setCachePolicy(ResourceRequestCachePolicy::ReloadIgnoringCacheData);
1787
1788     addSameSiteInfoToRequestIfNeeded(request);
1789
1790     // If we're about to re-post, set up action so the application can warn the user.
1791     if (request.httpMethod() == "POST")
1792         loader->setTriggeringAction({ *m_frame.document(), request, InitiatedByMainFrame::Unknown, NavigationType::FormResubmitted });
1793
1794     loader->setOverrideEncoding(m_documentLoader->overrideEncoding());
1795
1796     auto frameLoadTypeForReloadOptions = [] (auto options) {
1797         if (options & ReloadOption::FromOrigin)
1798             return FrameLoadType::ReloadFromOrigin;
1799         if (options & ReloadOption::ExpiredOnly)
1800             return FrameLoadType::ReloadExpiredOnly;
1801         return FrameLoadType::Reload;
1802     };
1803     
1804     loadWithDocumentLoader(loader.ptr(), frameLoadTypeForReloadOptions(options), { }, AllowNavigationToInvalidURL::Yes, ShouldTreatAsContinuingLoad::No);
1805 }
1806
1807 void FrameLoader::stopAllLoaders(ClearProvisionalItemPolicy clearProvisionalItemPolicy)
1808 {
1809     if (m_frame.document() && m_frame.document()->pageCacheState() == Document::InPageCache)
1810         return;
1811
1812     if (!isStopLoadingAllowed())
1813         return;
1814
1815     // If this method is called from within this method, infinite recursion can occur (3442218). Avoid this.
1816     if (m_inStopAllLoaders)
1817         return;
1818
1819     // This method might dispatch events.
1820     RELEASE_ASSERT_WITH_SECURITY_IMPLICATION(ScriptDisallowedScope::InMainThread::isScriptAllowed());
1821
1822     // Calling stopLoading() on the provisional document loader can blow away
1823     // the frame from underneath.
1824     Ref<Frame> protect(m_frame);
1825
1826     m_inStopAllLoaders = true;
1827
1828     policyChecker().stopCheck();
1829
1830     // If no new load is in progress, we should clear the provisional item from history
1831     // before we call stopLoading.
1832     if (clearProvisionalItemPolicy == ShouldClearProvisionalItem)
1833         history().setProvisionalItem(nullptr);
1834
1835     for (RefPtr<Frame> child = m_frame.tree().firstChild(); child; child = child->tree().nextSibling())
1836         child->loader().stopAllLoaders(clearProvisionalItemPolicy);
1837     if (m_provisionalDocumentLoader)
1838         m_provisionalDocumentLoader->stopLoading();
1839     if (m_documentLoader)
1840         m_documentLoader->stopLoading();
1841
1842     setProvisionalDocumentLoader(nullptr);
1843
1844     m_inStopAllLoaders = false;    
1845 }
1846
1847 void FrameLoader::stopAllLoadersAndCheckCompleteness()
1848 {
1849     stopAllLoaders();
1850
1851     if (!m_checkTimer.isActive())
1852         return;
1853
1854     m_checkTimer.stop();
1855     m_checkingLoadCompleteForDetachment = true;
1856     checkCompletenessNow();
1857     m_checkingLoadCompleteForDetachment = false;
1858 }
1859
1860 void FrameLoader::stopForUserCancel(bool deferCheckLoadComplete)
1861 {
1862     // Calling stopAllLoaders can cause the frame to be deallocated, including the frame loader.
1863     Ref<Frame> protectedFrame(m_frame);
1864
1865     stopAllLoaders();
1866
1867 #if PLATFORM(IOS_FAMILY)
1868     // Lay out immediately when stopping to immediately clear the old page if we just committed this one
1869     // but haven't laid out/painted yet.
1870     // FIXME: Is this behavior specific to iOS? Or should we expose a setting to toggle this behavior?
1871     if (m_frame.view() && !m_frame.view()->didFirstLayout())
1872         m_frame.view()->layoutContext().layout();
1873 #endif
1874
1875     if (deferCheckLoadComplete)
1876         scheduleCheckLoadComplete();
1877     else if (m_frame.page())
1878         checkLoadComplete();
1879 }
1880
1881 DocumentLoader* FrameLoader::activeDocumentLoader() const
1882 {
1883     if (m_state == FrameStateProvisional)
1884         return m_provisionalDocumentLoader.get();
1885     return m_documentLoader.get();
1886 }
1887
1888 bool FrameLoader::isLoading() const
1889 {
1890     DocumentLoader* docLoader = activeDocumentLoader();
1891     if (!docLoader)
1892         return false;
1893     return docLoader->isLoading();
1894 }
1895
1896 bool FrameLoader::frameHasLoaded() const
1897 {
1898     return m_stateMachine.committedFirstRealDocumentLoad() || (m_provisionalDocumentLoader && !m_stateMachine.creatingInitialEmptyDocument()); 
1899 }
1900
1901 void FrameLoader::setDocumentLoader(DocumentLoader* loader)
1902 {
1903     if (!loader && !m_documentLoader)
1904         return;
1905
1906     if (loader == m_documentLoader)
1907         return;
1908     
1909     ASSERT(loader != m_documentLoader);
1910     ASSERT(!loader || loader->frameLoader() == this);
1911
1912     m_client.prepareForDataSourceReplacement();
1913     detachChildren();
1914
1915     // detachChildren() can trigger this frame's unload event, and therefore
1916     // script can run and do just about anything. For example, an unload event that calls
1917     // document.write("") on its parent frame can lead to a recursive detachChildren()
1918     // invocation for this frame. In that case, we can end up at this point with a
1919     // loader that hasn't been deleted but has been detached from its frame. Such a
1920     // DocumentLoader has been sufficiently detached that we'll end up in an inconsistent
1921     // state if we try to use it.
1922     if (loader && !loader->frame())
1923         return;
1924
1925     if (m_documentLoader)
1926         m_documentLoader->detachFromFrame();
1927
1928     m_documentLoader = loader;
1929 }
1930
1931 void FrameLoader::setPolicyDocumentLoader(DocumentLoader* loader)
1932 {
1933     if (m_policyDocumentLoader == loader)
1934         return;
1935
1936     if (loader)
1937         loader->attachToFrame(m_frame);
1938     if (m_policyDocumentLoader
1939             && m_policyDocumentLoader != m_provisionalDocumentLoader
1940             && m_policyDocumentLoader != m_documentLoader)
1941         m_policyDocumentLoader->detachFromFrame();
1942
1943     m_policyDocumentLoader = loader;
1944 }
1945
1946 void FrameLoader::setProvisionalDocumentLoader(DocumentLoader* loader)
1947 {
1948     ASSERT(!loader || !m_provisionalDocumentLoader);
1949     ASSERT(!loader || loader->frameLoader() == this);
1950
1951     if (m_provisionalDocumentLoader && m_provisionalDocumentLoader != m_documentLoader)
1952         m_provisionalDocumentLoader->detachFromFrame();
1953
1954     m_provisionalDocumentLoader = loader;
1955 }
1956
1957 void FrameLoader::setState(FrameState newState)
1958 {
1959     FrameState oldState = m_state;
1960     m_state = newState;
1961     
1962     if (newState == FrameStateProvisional)
1963         provisionalLoadStarted();
1964     else if (newState == FrameStateComplete) {
1965         frameLoadCompleted();
1966         if (m_documentLoader)
1967             m_documentLoader->stopRecordingResponses();
1968         if (m_frame.isMainFrame() && oldState != newState) {
1969             RELEASE_LOG_IF_ALLOWED("setState: main frame load completed (frame = %p, main = %d)", &m_frame, m_frame.isMainFrame());
1970             m_frame.page()->performanceLogging().didReachPointOfInterest(PerformanceLogging::MainFrameLoadCompleted);
1971         }
1972     }
1973 }
1974
1975 void FrameLoader::clearProvisionalLoad()
1976 {
1977     setProvisionalDocumentLoader(nullptr);
1978     m_progressTracker->progressCompleted();
1979     setState(FrameStateComplete);
1980 }
1981
1982 void FrameLoader::commitProvisionalLoad()
1983 {
1984     RefPtr<DocumentLoader> pdl = m_provisionalDocumentLoader;
1985     Ref<Frame> protect(m_frame);
1986
1987     std::unique_ptr<CachedPage> cachedPage;
1988     if (m_loadingFromCachedPage && history().provisionalItem())
1989         cachedPage = PageCache::singleton().take(*history().provisionalItem(), m_frame.page());
1990
1991     LOG(PageCache, "WebCoreLoading %s: About to commit provisional load from previous URL '%s' to new URL '%s' with cached page %p", m_frame.tree().uniqueName().string().utf8().data(),
1992         m_frame.document() ? m_frame.document()->url().stringCenterEllipsizedToLength().utf8().data() : "",
1993         pdl ? pdl->url().stringCenterEllipsizedToLength().utf8().data() : "<no provisional DocumentLoader>", cachedPage.get());
1994
1995     willTransitionToCommitted();
1996
1997     if (!m_frame.tree().parent() && history().currentItem() && history().currentItem() != history().provisionalItem()) {
1998         // Check to see if we need to cache the page we are navigating away from into the back/forward cache.
1999         // We are doing this here because we know for sure that a new page is about to be loaded.
2000         PageCache::singleton().addIfCacheable(*history().currentItem(), m_frame.page());
2001         
2002         WebCore::jettisonExpensiveObjectsOnTopLevelNavigation();
2003     }
2004
2005     if (m_loadType != FrameLoadType::Replace)
2006         closeOldDataSources();
2007
2008     if (!cachedPage && !m_stateMachine.creatingInitialEmptyDocument())
2009         m_client.makeRepresentation(pdl.get());
2010
2011     transitionToCommitted(cachedPage.get());
2012
2013     if (pdl && m_documentLoader) {
2014         // Check if the destination page is allowed to access the previous page's timing information.
2015         Ref<SecurityOrigin> securityOrigin(SecurityOrigin::create(pdl->request().url()));
2016         m_documentLoader->timing().setHasSameOriginAsPreviousDocument(securityOrigin.get().canRequest(m_previousURL));
2017     }
2018
2019     // Call clientRedirectCancelledOrFinished() here so that the frame load delegate is notified that the redirect's
2020     // status has changed, if there was a redirect.  The frame load delegate may have saved some state about
2021     // the redirect in its -webView:willPerformClientRedirectToURL:delay:fireDate:forFrame:.  Since we are
2022     // just about to commit a new page, there cannot possibly be a pending redirect at this point.
2023     if (m_sentRedirectNotification)
2024         clientRedirectCancelledOrFinished(NewLoadInProgress::No);
2025     
2026     if (cachedPage && cachedPage->document()) {
2027 #if PLATFORM(IOS_FAMILY)
2028         // FIXME: CachedPage::restore() would dispatch viewport change notification. However UIKit expects load
2029         // commit to happen before any changes to viewport arguments and dealing with this there is difficult.
2030         m_frame.page()->chrome().setDispatchViewportDataDidChangeSuppressed(true);
2031 #endif
2032         willRestoreFromCachedPage();
2033
2034         // Start request for the main resource and dispatch didReceiveResponse before the load is committed for
2035         // consistency with all other loads. See https://bugs.webkit.org/show_bug.cgi?id=150927.
2036         ResourceError mainResouceError;
2037         unsigned long mainResourceIdentifier;
2038         ResourceRequest mainResourceRequest(cachedPage->documentLoader()->request());
2039         requestFromDelegate(mainResourceRequest, mainResourceIdentifier, mainResouceError);
2040         notifier().dispatchDidReceiveResponse(cachedPage->documentLoader(), mainResourceIdentifier, cachedPage->documentLoader()->response());
2041
2042         Optional<HasInsecureContent> hasInsecureContent = cachedPage->cachedMainFrame()->hasInsecureContent();
2043
2044         dispatchDidCommitLoad(hasInsecureContent);
2045
2046         // FIXME: This API should be turned around so that we ground CachedPage into the Page.
2047         cachedPage->restore(*m_frame.page());
2048
2049 #if PLATFORM(IOS_FAMILY)
2050         m_frame.page()->chrome().setDispatchViewportDataDidChangeSuppressed(false);
2051         m_frame.page()->chrome().dispatchViewportPropertiesDidChange(m_frame.page()->viewportArguments());
2052 #endif
2053         m_frame.page()->chrome().dispatchDisabledAdaptationsDidChange(m_frame.page()->disabledAdaptations());
2054
2055         auto& title = m_documentLoader->title();
2056         if (!title.string.isNull())
2057             m_client.dispatchDidReceiveTitle(title);
2058
2059         // Send remaining notifications for the main resource.
2060         notifier().sendRemainingDelegateMessages(m_documentLoader.get(), mainResourceIdentifier, mainResourceRequest, ResourceResponse(),
2061             nullptr, static_cast<int>(m_documentLoader->response().expectedContentLength()), 0, mainResouceError);
2062
2063         checkCompleted();
2064     } else
2065         didOpenURL();
2066
2067     LOG(Loading, "WebCoreLoading %s: Finished committing provisional load to URL %s", m_frame.tree().uniqueName().string().utf8().data(),
2068         m_frame.document() ? m_frame.document()->url().stringCenterEllipsizedToLength().utf8().data() : "");
2069
2070     if (m_loadType == FrameLoadType::Standard && m_documentLoader && m_documentLoader->isClientRedirect())
2071         history().updateForClientRedirect();
2072
2073     if (m_loadingFromCachedPage) {
2074         // Note, didReceiveDocType is expected to be called for cached pages. See <rdar://problem/5906758> for more details.
2075         if (auto* page = m_frame.page())
2076             page->chrome().didReceiveDocType(m_frame);
2077         m_frame.document()->resume(ReasonForSuspension::PageCache);
2078
2079         // Force a layout to update view size and thereby update scrollbars.
2080 #if PLATFORM(IOS_FAMILY)
2081         if (!m_client.forceLayoutOnRestoreFromPageCache())
2082             m_frame.view()->forceLayout();
2083 #else
2084         m_frame.view()->forceLayout();
2085 #endif
2086
2087         // Main resource delegates were already sent, so we skip the first response here.
2088         for (unsigned i = 1; i < m_documentLoader->responses().size(); ++i) {
2089             const auto& response = m_documentLoader->responses()[i];
2090             // FIXME: If the WebKit client changes or cancels the request, this is not respected.
2091             ResourceError error;
2092             unsigned long identifier;
2093             ResourceRequest request(response.url());
2094             requestFromDelegate(request, identifier, error);
2095             // FIXME: If we get a resource with more than 2B bytes, this code won't do the right thing.
2096             // However, with today's computers and networking speeds, this won't happen in practice.
2097             // Could be an issue with a giant local file.
2098             notifier().sendRemainingDelegateMessages(m_documentLoader.get(), identifier, request, response, 0, static_cast<int>(response.expectedContentLength()), 0, error);
2099         }
2100
2101         // FIXME: Why only this frame and not parent frames?
2102         checkLoadCompleteForThisFrame();
2103     }
2104 }
2105
2106 void FrameLoader::transitionToCommitted(CachedPage* cachedPage)
2107 {
2108     ASSERT(m_client.hasWebView());
2109     ASSERT(m_state == FrameStateProvisional);
2110
2111     if (m_state != FrameStateProvisional)
2112         return;
2113
2114     if (FrameView* view = m_frame.view()) {
2115         if (ScrollAnimator* scrollAnimator = view->existingScrollAnimator())
2116             scrollAnimator->cancelAnimations();
2117     }
2118
2119     m_client.setCopiesOnScroll();
2120     history().updateForCommit();
2121
2122     // The call to closeURL() invokes the unload event handler, which can execute arbitrary
2123     // JavaScript. If the script initiates a new load, we need to abandon the current load,
2124     // or the two will stomp each other.
2125     DocumentLoader* pdl = m_provisionalDocumentLoader.get();
2126     if (m_documentLoader)
2127         closeURL();
2128     if (pdl != m_provisionalDocumentLoader)
2129         return;
2130
2131     if (m_documentLoader)
2132         m_documentLoader->stopLoadingSubresources();
2133     if (m_documentLoader)
2134         m_documentLoader->stopLoadingPlugIns();
2135
2136     // Setting our document loader invokes the unload event handler of our child frames.
2137     // Script can do anything. If the script initiates a new load, we need to abandon the
2138     // current load or the two will stomp each other.
2139     setDocumentLoader(m_provisionalDocumentLoader.get());
2140     if (pdl != m_provisionalDocumentLoader)
2141         return;
2142     setProvisionalDocumentLoader(nullptr);
2143
2144     // Nothing else can interrupt this commit - set the Provisional->Committed transition in stone
2145     setState(FrameStateCommittedPage);
2146
2147     // Handle adding the URL to the back/forward list.
2148     DocumentLoader* dl = m_documentLoader.get();
2149
2150     switch (m_loadType) {
2151     case FrameLoadType::Forward:
2152     case FrameLoadType::Back:
2153     case FrameLoadType::IndexedBackForward:
2154         if (m_frame.page()) {
2155             // If the first load within a frame is a navigation within a back/forward list that was attached
2156             // without any of the items being loaded then we need to update the history in a similar manner as
2157             // for a standard load with the exception of updating the back/forward list (<rdar://problem/8091103>).
2158             if (!m_stateMachine.committedFirstRealDocumentLoad() && m_frame.isMainFrame())
2159                 history().updateForStandardLoad(HistoryController::UpdateAllExceptBackForwardList);
2160
2161             history().updateForBackForwardNavigation();
2162
2163             // For cached pages, CachedFrame::restore will take care of firing the popstate event with the history item's state object
2164             if (history().currentItem() && !cachedPage)
2165                 m_pendingStateObject = history().currentItem()->stateObject();
2166
2167             // Create a document view for this document, or used the cached view.
2168             if (cachedPage) {
2169                 DocumentLoader* cachedDocumentLoader = cachedPage->documentLoader();
2170                 ASSERT(cachedDocumentLoader);
2171                 cachedDocumentLoader->attachToFrame(m_frame);
2172                 m_client.transitionToCommittedFromCachedFrame(cachedPage->cachedMainFrame());
2173             } else
2174                 m_client.transitionToCommittedForNewPage();
2175         }
2176         break;
2177
2178     case FrameLoadType::Reload:
2179     case FrameLoadType::ReloadFromOrigin:
2180     case FrameLoadType::ReloadExpiredOnly:
2181     case FrameLoadType::Same:
2182     case FrameLoadType::Replace:
2183         history().updateForReload();
2184         m_client.transitionToCommittedForNewPage();
2185         break;
2186
2187     case FrameLoadType::Standard:
2188         history().updateForStandardLoad();
2189         if (m_frame.view())
2190             m_frame.view()->setScrollbarsSuppressed(true);
2191         m_client.transitionToCommittedForNewPage();
2192         break;
2193
2194     case FrameLoadType::RedirectWithLockedBackForwardList:
2195         history().updateForRedirectWithLockedBackForwardList();
2196         m_client.transitionToCommittedForNewPage();
2197         break;
2198     }
2199
2200     m_documentLoader->writer().setMIMEType(dl->responseMIMEType());
2201
2202     // Tell the client we've committed this URL.
2203     ASSERT(m_frame.view());
2204
2205     if (m_stateMachine.creatingInitialEmptyDocument())
2206         return;
2207
2208     if (!m_stateMachine.committedFirstRealDocumentLoad())
2209         m_stateMachine.advanceTo(FrameLoaderStateMachine::DisplayingInitialEmptyDocumentPostCommit);
2210 }
2211
2212 void FrameLoader::clientRedirectCancelledOrFinished(NewLoadInProgress newLoadInProgress)
2213 {
2214     // Note that -webView:didCancelClientRedirectForFrame: is called on the frame load delegate even if
2215     // the redirect succeeded.  We should either rename this API, or add a new method, like
2216     // -webView:didFinishClientRedirectForFrame:
2217     m_client.dispatchDidCancelClientRedirect();
2218
2219     if (newLoadInProgress == NewLoadInProgress::No)
2220         m_quickRedirectComing = false;
2221
2222     m_sentRedirectNotification = false;
2223 }
2224
2225 void FrameLoader::clientRedirected(const URL& url, double seconds, WallTime fireDate, LockBackForwardList lockBackForwardList)
2226 {
2227     m_client.dispatchWillPerformClientRedirect(url, seconds, fireDate, lockBackForwardList);
2228     
2229     // Remember that we sent a redirect notification to the frame load delegate so that when we commit
2230     // the next provisional load, we can send a corresponding -webView:didCancelClientRedirectForFrame:
2231     m_sentRedirectNotification = true;
2232     
2233     // If a "quick" redirect comes in, we set a special mode so we treat the next
2234     // load as part of the original navigation. If we don't have a document loader, we have
2235     // no "original" load on which to base a redirect, so we treat the redirect as a normal load.
2236     // Loads triggered by JavaScript form submissions never count as quick redirects.
2237     m_quickRedirectComing = (lockBackForwardList == LockBackForwardList::Yes || history().currentItemShouldBeReplaced()) && m_documentLoader && !m_isExecutingJavaScriptFormAction;
2238 }
2239
2240 bool FrameLoader::shouldReload(const URL& currentURL, const URL& destinationURL)
2241 {
2242     // This function implements the rule: "Don't reload if navigating by fragment within
2243     // the same URL, but do reload if going to a new URL or to the same URL with no
2244     // fragment identifier at all."
2245     if (!destinationURL.hasFragmentIdentifier())
2246         return true;
2247     return !equalIgnoringFragmentIdentifier(currentURL, destinationURL);
2248 }
2249
2250 void FrameLoader::closeOldDataSources()
2251 {
2252     // FIXME: Is it important for this traversal to be postorder instead of preorder?
2253     // If so, add helpers for postorder traversal, and use them. If not, then lets not
2254     // use a recursive algorithm here.
2255     for (Frame* child = m_frame.tree().firstChild(); child; child = child->tree().nextSibling())
2256         child->loader().closeOldDataSources();
2257     
2258     if (m_documentLoader)
2259         m_client.dispatchWillClose();
2260
2261     m_client.setMainFrameDocumentReady(false); // stop giving out the actual DOMDocument to observers
2262 }
2263
2264 void FrameLoader::willRestoreFromCachedPage()
2265 {
2266     ASSERT(!m_frame.tree().parent());
2267     ASSERT(m_frame.page());
2268     ASSERT(m_frame.isMainFrame());
2269
2270     m_frame.navigationScheduler().cancel();
2271
2272     // We still have to close the previous part page.
2273     closeURL();
2274     
2275     // Delete old status bar messages (if it _was_ activated on last URL).
2276     if (m_frame.script().canExecuteScripts(NotAboutToExecuteScript)) {
2277         DOMWindow* window = m_frame.document()->domWindow();
2278         window->setStatus(String());
2279         window->setDefaultStatus(String());
2280     }
2281 }
2282
2283 void FrameLoader::open(CachedFrameBase& cachedFrame)
2284 {
2285     m_isComplete = false;
2286     
2287     // Don't re-emit the load event.
2288     m_didCallImplicitClose = true;
2289
2290     URL url = cachedFrame.url();
2291
2292     // FIXME: I suspect this block of code doesn't do anything.
2293     if (url.protocolIsInHTTPFamily() && !url.host().isEmpty() && url.path().isEmpty())
2294         url.setPath("/");
2295
2296     started();
2297     Document* document = cachedFrame.document();
2298     ASSERT(document);
2299     ASSERT(document->domWindow());
2300
2301     clear(document, true, true, cachedFrame.isMainFrame());
2302
2303     document->setPageCacheState(Document::NotInPageCache);
2304
2305     m_needsClear = true;
2306     m_isComplete = false;
2307     m_didCallImplicitClose = false;
2308     m_outgoingReferrer = url.string();
2309
2310     FrameView* view = cachedFrame.view();
2311     
2312     // When navigating to a CachedFrame its FrameView should never be null.  If it is we'll crash in creative ways downstream.
2313     ASSERT(view);
2314     view->setWasScrolledByUser(false);
2315
2316     Optional<IntRect> previousViewFrameRect = m_frame.view() ?  m_frame.view()->frameRect() : Optional<IntRect>(WTF::nullopt);
2317     m_frame.setView(view);
2318
2319     // Use the previous ScrollView's frame rect.
2320     if (previousViewFrameRect)
2321         view->setFrameRect(previousViewFrameRect.value());
2322
2323     {
2324         // Setting the document builds the render tree and runs post style resolution callbacks that can do anything,
2325         // including loading a child frame before its been re-attached to the frame tree as part of this restore.
2326         // For example, the HTML object element may load its content into a frame in a post style resolution callback.
2327         NavigationDisabler disableNavigation { &m_frame };
2328         m_frame.setDocument(document);
2329     }
2330
2331     document->domWindow()->resumeFromPageCache();
2332
2333     updateFirstPartyForCookies();
2334
2335     cachedFrame.restore();
2336 }
2337
2338 bool FrameLoader::isHostedByObjectElement() const
2339 {
2340     HTMLFrameOwnerElement* owner = m_frame.ownerElement();
2341     return owner && owner->hasTagName(objectTag);
2342 }
2343
2344 bool FrameLoader::isReplacing() const
2345 {
2346     return m_loadType == FrameLoadType::Replace;
2347 }
2348
2349 void FrameLoader::setReplacing()
2350 {
2351     m_loadType = FrameLoadType::Replace;
2352 }
2353
2354 bool FrameLoader::subframeIsLoading() const
2355 {
2356     // It's most likely that the last added frame is the last to load so we walk backwards.
2357     for (Frame* child = m_frame.tree().lastChild(); child; child = child->tree().previousSibling()) {
2358         FrameLoader& childLoader = child->loader();
2359         DocumentLoader* documentLoader = childLoader.documentLoader();
2360         if (documentLoader && documentLoader->isLoadingInAPISense())
2361             return true;
2362         documentLoader = childLoader.provisionalDocumentLoader();
2363         if (documentLoader && documentLoader->isLoadingInAPISense())
2364             return true;
2365         documentLoader = childLoader.policyDocumentLoader();
2366         if (documentLoader)
2367             return true;
2368     }
2369     return false;
2370 }
2371
2372 void FrameLoader::willChangeTitle(DocumentLoader* loader)
2373 {
2374     m_client.willChangeTitle(loader);
2375 }
2376
2377 FrameLoadType FrameLoader::loadType() const
2378 {
2379     return m_loadType;
2380 }
2381     
2382 CachePolicy FrameLoader::subresourceCachePolicy(const URL& url) const
2383 {
2384     if (Page* page = m_frame.page()) {
2385         if (page->isResourceCachingDisabled())
2386             return CachePolicyReload;
2387     }
2388
2389     if (m_isComplete)
2390         return CachePolicyVerify;
2391
2392     if (m_loadType == FrameLoadType::ReloadFromOrigin)
2393         return CachePolicyReload;
2394
2395     if (Frame* parentFrame = m_frame.tree().parent()) {
2396         CachePolicy parentCachePolicy = parentFrame->loader().subresourceCachePolicy(url);
2397         if (parentCachePolicy != CachePolicyVerify)
2398             return parentCachePolicy;
2399     }
2400     
2401     switch (m_loadType) {
2402     case FrameLoadType::Reload:
2403         return CachePolicyRevalidate;
2404     case FrameLoadType::Back:
2405     case FrameLoadType::Forward:
2406     case FrameLoadType::IndexedBackForward:
2407         return CachePolicyHistoryBuffer;
2408     case FrameLoadType::ReloadFromOrigin:
2409         ASSERT_NOT_REACHED(); // Already handled above.
2410         return CachePolicyReload;
2411     case FrameLoadType::RedirectWithLockedBackForwardList:
2412     case FrameLoadType::Replace:
2413     case FrameLoadType::Same:
2414     case FrameLoadType::Standard:
2415         return CachePolicyVerify;
2416     case FrameLoadType::ReloadExpiredOnly:
2417         // We know about expiration for HTTP and data. Do a normal reload otherwise.
2418         if (!url.protocolIsInHTTPFamily() && !url.protocolIsData())
2419             return CachePolicyReload;
2420         return CachePolicyVerify;
2421     }
2422
2423     RELEASE_ASSERT_NOT_REACHED();
2424     return CachePolicyVerify;
2425 }
2426
2427 void FrameLoader::checkLoadCompleteForThisFrame()
2428 {
2429     ASSERT(m_client.hasWebView());
2430
2431     // FIXME: Should this check be done in checkLoadComplete instead of here?
2432     // FIXME: Why does this one check need to be repeated here, and not the many others from checkCompleted?
2433     if (m_frame.document()->isDelayingLoadEvent())
2434         return;
2435
2436     switch (m_state) {
2437         case FrameStateProvisional: {
2438             // FIXME: Prohibiting any provisional load failures from being sent to clients
2439             // while handling provisional load failures is too heavy. For example, the current
2440             // load will fail to cancel another ongoing load. That might prevent clients' page
2441             // load state being handled properly.
2442             if (!m_provisionalLoadErrorBeingHandledURL.isEmpty())
2443                 return;
2444
2445             RefPtr<DocumentLoader> pdl = m_provisionalDocumentLoader;
2446             if (!pdl)
2447                 return;
2448                 
2449             // If we've received any errors we may be stuck in the provisional state and actually complete.
2450             const ResourceError& error = pdl->mainDocumentError();
2451             if (error.isNull())
2452                 return;
2453
2454             // Check all children first.
2455             RefPtr<HistoryItem> item;
2456             if (Page* page = m_frame.page())
2457                 if (isBackForwardLoadType(loadType()))
2458                     // Reset the back forward list to the last committed history item at the top level.
2459                     item = page->mainFrame().loader().history().currentItem();
2460                 
2461             // Only reset if we aren't already going to a new provisional item.
2462             bool shouldReset = !history().provisionalItem();
2463             if (!pdl->isLoadingInAPISense() || pdl->isStopping()) {
2464                 RELEASE_LOG_IF_ALLOWED("checkLoadCompleteForThisFrame: Failed provisional load (frame = %p, main = %d, isTimeout = %d, isCancellation = %d, errorCode = %d)", &m_frame, m_frame.isMainFrame(), error.isTimeout(), error.isCancellation(), error.errorCode());
2465                 m_provisionalLoadErrorBeingHandledURL = m_provisionalDocumentLoader->url();
2466                 m_client.dispatchDidFailProvisionalLoad(error);
2467 #if ENABLE(CONTENT_FILTERING)
2468                 if (auto contentFilter = pdl->contentFilter())
2469                     contentFilter->handleProvisionalLoadFailure(error);
2470 #endif
2471                 m_provisionalLoadErrorBeingHandledURL = { };
2472
2473                 ASSERT(!pdl->isLoading());
2474
2475                 // If we're in the middle of loading multipart data, we need to restore the document loader.
2476                 if (isReplacing() && !m_documentLoader.get())
2477                     setDocumentLoader(m_provisionalDocumentLoader.get());
2478
2479                 // Finish resetting the load state, but only if another load hasn't been started by the
2480                 // delegate callback.
2481                 if (pdl == m_provisionalDocumentLoader)
2482                     clearProvisionalLoad();
2483                 else if (activeDocumentLoader()) {
2484                     URL unreachableURL = activeDocumentLoader()->unreachableURL();
2485                     if (!unreachableURL.isEmpty() && unreachableURL == pdl->request().url())
2486                         shouldReset = false;
2487                 }
2488             }
2489             if (shouldReset && item)
2490                 if (Page* page = m_frame.page()) {
2491                     page->backForward().setCurrentItem(*item);
2492                 }
2493             return;
2494         }
2495         
2496         case FrameStateCommittedPage: {
2497             if (!m_documentLoader)
2498                 return;
2499             if (m_documentLoader->isLoadingInAPISense() && !m_documentLoader->isStopping() && !m_checkingLoadCompleteForDetachment)
2500                 return;
2501
2502             setState(FrameStateComplete);
2503
2504             // FIXME: Is this subsequent work important if we already navigated away?
2505             // Maybe there are bugs because of that, or extra work we can skip because
2506             // the new page is ready.
2507
2508             m_client.forceLayoutForNonHTML();
2509              
2510             // If the user had a scroll point, scroll to it, overriding the anchor point if any.
2511             if (m_frame.page()) {
2512                 if (isBackForwardLoadType(m_loadType) || isReload(m_loadType))
2513                     history().restoreScrollPositionAndViewState();
2514             }
2515
2516             if (m_stateMachine.creatingInitialEmptyDocument() || !m_stateMachine.committedFirstRealDocumentLoad())
2517                 return;
2518
2519             m_progressTracker->progressCompleted();
2520             Page* page = m_frame.page();
2521             if (page) {
2522                 if (m_frame.isMainFrame()) {
2523                     tracePoint(MainResourceLoadDidEnd);
2524                     page->didFinishLoad();
2525                 }
2526             }
2527
2528             const ResourceError& error = m_documentLoader->mainDocumentError();
2529
2530             AXObjectCache::AXLoadingEvent loadingEvent;
2531             if (!error.isNull()) {
2532                 RELEASE_LOG_IF_ALLOWED("checkLoadCompleteForThisFrame: Finished frame load with error (frame = %p, main = %d, isTimeout = %d, isCancellation = %d, errorCode = %d)", &m_frame, m_frame.isMainFrame(), error.isTimeout(), error.isCancellation(), error.errorCode());
2533                 m_client.dispatchDidFailLoad(error);
2534                 loadingEvent = AXObjectCache::AXLoadingFailed;
2535             } else {
2536                 RELEASE_LOG_IF_ALLOWED("checkLoadCompleteForThisFrame: Finished frame load (frame = %p, main = %d)", &m_frame, m_frame.isMainFrame());
2537 #if ENABLE(DATA_DETECTION)
2538                 auto* document = m_frame.document();
2539                 if (m_frame.settings().dataDetectorTypes() != DataDetectorTypeNone && document) {
2540                     if (auto* documentElement = document->documentElement()) {
2541                         RefPtr<Range> documentRange = makeRange(firstPositionInNode(documentElement), lastPositionInNode(documentElement));
2542                         m_frame.setDataDetectionResults(DataDetection::detectContentInRange(documentRange, m_frame.settings().dataDetectorTypes(), m_client.dataDetectionContext()));
2543                         if (m_frame.isMainFrame())
2544                             m_client.dispatchDidFinishDataDetection(m_frame.dataDetectionResults());
2545                     }
2546                 }
2547 #endif
2548                 m_client.dispatchDidFinishLoad();
2549                 loadingEvent = AXObjectCache::AXLoadingFinished;
2550             }
2551
2552             // Notify accessibility.
2553             if (auto* document = m_frame.document()) {
2554                 if (AXObjectCache* cache = document->existingAXObjectCache())
2555                     cache->frameLoadingEventNotification(&m_frame, loadingEvent);
2556             }
2557
2558             // The above calls to dispatchDidFinishLoad() might have detached the Frame
2559             // from its Page and also might have caused Page to be deleted.
2560             // Don't assume 'page' is still available to use.
2561             if (m_frame.isMainFrame() && m_frame.page()) {
2562                 ASSERT(&m_frame.page()->mainFrame() == &m_frame);
2563                 m_frame.page()->diagnosticLoggingClient().logDiagnosticMessageWithResult(DiagnosticLoggingKeys::pageLoadedKey(), emptyString(), error.isNull() ? DiagnosticLoggingResultPass : DiagnosticLoggingResultFail, ShouldSample::Yes);
2564             }
2565
2566             return;
2567         }
2568         
2569         case FrameStateComplete:
2570             m_loadType = FrameLoadType::Standard;
2571             frameLoadCompleted();
2572             return;
2573     }
2574
2575     ASSERT_NOT_REACHED();
2576 }
2577
2578 void FrameLoader::setOriginalURLForDownloadRequest(ResourceRequest& request)
2579 {
2580     // FIXME: Rename firstPartyForCookies back to mainDocumentURL. It was a mistake to think that it was only used for cookies.
2581     // The originalURL is defined as the URL of the page where the download was initiated.
2582     URL originalURL;
2583     auto* initiator = m_frame.document();
2584     if (initiator) {
2585         originalURL = initiator->firstPartyForCookies();
2586         // If there is no main document URL, it means that this document is newly opened and just for download purpose.
2587         // In this case, we need to set the originalURL to this document's opener's main document URL.
2588         if (originalURL.isEmpty() && opener() && opener()->document()) {
2589             originalURL = opener()->document()->firstPartyForCookies();
2590             initiator = opener()->document();
2591         }
2592     }
2593     // If the originalURL is the same as the requested URL, we are processing a download
2594     // initiated directly without a page and do not need to specify the originalURL.
2595     if (originalURL == request.url())
2596         request.setFirstPartyForCookies(URL());
2597     else
2598         request.setFirstPartyForCookies(originalURL);
2599     addSameSiteInfoToRequestIfNeeded(request, initiator);
2600 }
2601
2602 void FrameLoader::didReachLayoutMilestone(OptionSet<LayoutMilestone> milestones)
2603 {
2604     ASSERT(m_frame.isMainFrame());
2605
2606     m_client.dispatchDidReachLayoutMilestone(milestones);
2607 }
2608
2609 void FrameLoader::didFirstLayout()
2610 {
2611 #if PLATFORM(IOS_FAMILY)
2612     // Only send layout-related delegate callbacks synchronously for the main frame to
2613     // avoid reentering layout for the main frame while delivering a layout-related delegate
2614     // callback for a subframe.
2615     if (&m_frame != &m_frame.page()->mainFrame())
2616         return;
2617 #endif
2618     if (m_frame.page() && isBackForwardLoadType(m_loadType))
2619         history().restoreScrollPositionAndViewState();
2620
2621     if (m_stateMachine.committedFirstRealDocumentLoad() && !m_stateMachine.isDisplayingInitialEmptyDocument() && !m_stateMachine.firstLayoutDone())
2622         m_stateMachine.advanceTo(FrameLoaderStateMachine::FirstLayoutDone);
2623 }
2624
2625 void FrameLoader::frameLoadCompleted()
2626 {
2627     // Note: Can be called multiple times.
2628
2629     m_client.frameLoadCompleted();
2630
2631     history().updateForFrameLoadCompleted();
2632
2633     // After a canceled provisional load, firstLayoutDone is false.
2634     // Reset it to true if we're displaying a page.
2635     if (m_documentLoader && m_stateMachine.committedFirstRealDocumentLoad() && !m_stateMachine.isDisplayingInitialEmptyDocument() && !m_stateMachine.firstLayoutDone())
2636         m_stateMachine.advanceTo(FrameLoaderStateMachine::FirstLayoutDone);
2637 }
2638
2639 void FrameLoader::detachChildren()
2640 {
2641     // detachChildren() will fire the unload event in each subframe and the
2642     // HTML specification states that the parent document's ignore-opens-during-unload counter while
2643     // this event is being fired in its subframes:
2644     // https://html.spec.whatwg.org/multipage/browsers.html#unload-a-document
2645     IgnoreOpensDuringUnloadCountIncrementer ignoreOpensDuringUnloadCountIncrementer(m_frame.document());
2646
2647     // Any subframe inserted by unload event handlers executed in the loop below will not get unloaded
2648     // because we create a copy of the subframes list before looping. Therefore, it would be unsafe to
2649     // allow loading of subframes at this point.
2650     SubframeLoadingDisabler subframeLoadingDisabler(m_frame.document());
2651
2652     Vector<Ref<Frame>, 16> childrenToDetach;
2653     childrenToDetach.reserveInitialCapacity(m_frame.tree().childCount());
2654     for (Frame* child = m_frame.tree().lastChild(); child; child = child->tree().previousSibling())
2655         childrenToDetach.uncheckedAppend(*child);
2656     for (auto& child : childrenToDetach)
2657         child->loader().detachFromParent();
2658 }
2659
2660 void FrameLoader::closeAndRemoveChild(Frame& child)
2661 {
2662     child.tree().detachFromParent();
2663
2664     child.setView(nullptr);
2665     if (child.ownerElement() && child.page())
2666         child.page()->decrementSubframeCount();
2667     child.willDetachPage();
2668     child.detachFromPage();
2669
2670     m_frame.tree().removeChild(child);
2671 }
2672
2673 // Called every time a resource is completely loaded or an error is received.
2674 void FrameLoader::checkLoadComplete()
2675 {
2676     m_shouldCallCheckLoadComplete = false;
2677
2678     if (!m_frame.page())
2679         return;
2680
2681     ASSERT(m_client.hasWebView());
2682     
2683     // FIXME: Always traversing the entire frame tree is a bit inefficient, but 
2684     // is currently needed in order to null out the previous history item for all frames.
2685     Vector<Ref<Frame>, 16> frames;
2686     for (Frame* frame = &m_frame.mainFrame(); frame; frame = frame->tree().traverseNext())
2687         frames.append(*frame);
2688
2689     // To process children before their parents, iterate the vector backwards.
2690     for (auto frame = frames.rbegin(); frame != frames.rend(); ++frame) {
2691         if ((*frame)->page())
2692             (*frame)->loader().checkLoadCompleteForThisFrame();
2693     }
2694 }
2695
2696 int FrameLoader::numPendingOrLoadingRequests(bool recurse) const
2697 {
2698     if (!recurse)
2699         return m_frame.document()->cachedResourceLoader().requestCount();
2700
2701     int count = 0;
2702     for (Frame* frame = &m_frame; frame; frame = frame->tree().traverseNext(&m_frame))
2703         count += frame->document()->cachedResourceLoader().requestCount();
2704     return count;
2705 }
2706
2707 String FrameLoader::userAgent(const URL& url) const
2708 {
2709     String userAgent;
2710
2711     if (auto* documentLoader = m_frame.mainFrame().loader().activeDocumentLoader())
2712         userAgent = documentLoader->customUserAgent();
2713
2714     InspectorInstrumentation::applyUserAgentOverride(m_frame, userAgent);
2715
2716     if (!userAgent.isEmpty())
2717         return userAgent;
2718
2719     return m_client.userAgent(url);
2720 }
2721
2722 String FrameLoader::userAgentForJavaScript(const URL& url) const
2723 {
2724     String userAgent;
2725
2726     if (auto* documentLoader = m_frame.mainFrame().loader().activeDocumentLoader()) {
2727         if (m_frame.settings().needsSiteSpecificQuirks())
2728             userAgent = documentLoader->customJavaScriptUserAgentAsSiteSpecificQuirks();
2729         if (userAgent.isEmpty())
2730             userAgent = documentLoader->customUserAgent();
2731     }
2732
2733     InspectorInstrumentation::applyUserAgentOverride(m_frame, userAgent);
2734
2735     if (!userAgent.isEmpty())
2736         return userAgent;
2737
2738     return m_client.userAgent(url);
2739 }
2740     
2741 String FrameLoader::navigatorPlatform() const
2742 {
2743     if (auto* documentLoader = m_frame.mainFrame().loader().activeDocumentLoader()) {
2744         auto& customNavigatorPlatform = documentLoader->customNavigatorPlatform();
2745         if (!customNavigatorPlatform.isEmpty())
2746             return customNavigatorPlatform;
2747     }
2748     return String();
2749 }
2750
2751 void FrameLoader::dispatchOnloadEvents()
2752 {
2753     m_client.dispatchDidDispatchOnloadEvents();
2754
2755     if (documentLoader())
2756         documentLoader()->dispatchOnloadEvents();
2757 }
2758
2759 void FrameLoader::frameDetached()
2760 {
2761     // Calling stopAllLoadersAndCheckCompleteness() can cause the frame to be deallocated, including the frame loader.
2762     Ref<Frame> protectedFrame(m_frame);
2763
2764     if (m_checkTimer.isActive()) {
2765         m_checkTimer.stop();
2766         checkCompletenessNow();
2767     }
2768
2769     if (m_frame.document()->pageCacheState() != Document::InPageCache) {
2770         stopAllLoadersAndCheckCompleteness();
2771         m_frame.document()->stopActiveDOMObjects();
2772     }
2773
2774     detachFromParent();
2775 }
2776
2777 void FrameLoader::detachFromParent()
2778 {
2779     // Calling stopAllLoaders() can cause the frame to be deallocated, including the frame loader.
2780     Ref<Frame> protect(m_frame);
2781
2782     closeURL();
2783     history().saveScrollPositionAndViewStateToItem(history().currentItem());
2784     detachChildren();
2785     if (m_frame.document()->pageCacheState() != Document::InPageCache) {
2786         // stopAllLoaders() needs to be called after detachChildren() if the document is not in the page cache,
2787         // because detachedChildren() will trigger the unload event handlers of any child frames, and those event
2788         // handlers might start a new subresource load in this frame.
2789         stopAllLoaders();
2790     }
2791
2792     InspectorInstrumentation::frameDetachedFromParent(m_frame);
2793
2794     detachViewsAndDocumentLoader();
2795
2796     m_progressTracker = nullptr;
2797
2798     if (Frame* parent = m_frame.tree().parent()) {
2799         parent->loader().closeAndRemoveChild(m_frame);
2800         parent->loader().scheduleCheckCompleted();
2801         parent->loader().scheduleCheckLoadComplete();
2802     } else {
2803         m_frame.setView(nullptr);
2804         m_frame.willDetachPage();
2805         m_frame.detachFromPage();
2806     }
2807 }
2808
2809 void FrameLoader::detachViewsAndDocumentLoader()
2810 {
2811     m_client.detachedFromParent2();
2812     setDocumentLoader(nullptr);
2813     m_client.detachedFromParent3();
2814 }
2815     
2816 void FrameLoader::addExtraFieldsToSubresourceRequest(ResourceRequest& request)
2817 {
2818     addExtraFieldsToRequest(request, m_loadType, false);
2819 }
2820
2821 void FrameLoader::addExtraFieldsToMainResourceRequest(ResourceRequest& request)
2822 {
2823     // FIXME: Using m_loadType seems wrong for some callers.
2824     // If we are only preparing to load the main resource, that is previous load's load type!
2825     addExtraFieldsToRequest(request, m_loadType, true);
2826
2827     // Upgrade-Insecure-Requests should only be added to main resource requests
2828     addHTTPUpgradeInsecureRequestsIfNeeded(request);
2829 }
2830
2831 ResourceRequestCachePolicy FrameLoader::defaultRequestCachingPolicy(const ResourceRequest& request, FrameLoadType loadType, bool isMainResource)
2832 {
2833     if (m_overrideCachePolicyForTesting)
2834         return m_overrideCachePolicyForTesting.value();
2835
2836     if (isMainResource) {
2837         if (isReload(loadType) || request.isConditional())
2838             return ResourceRequestCachePolicy::ReloadIgnoringCacheData;
2839
2840         return ResourceRequestCachePolicy::UseProtocolCachePolicy;
2841     }
2842
2843     if (request.isConditional())
2844         return ResourceRequestCachePolicy::ReloadIgnoringCacheData;
2845
2846     if (documentLoader()->isLoadingInAPISense()) {
2847         // If we inherit cache policy from a main resource, we use the DocumentLoader's
2848         // original request cache policy for two reasons:
2849         // 1. For POST requests, we mutate the cache policy for the main resource,
2850         //    but we do not want this to apply to subresources
2851         // 2. Delegates that modify the cache policy using willSendRequest: should
2852         //    not affect any other resources. Such changes need to be done
2853         //    per request.
2854         ResourceRequestCachePolicy mainDocumentOriginalCachePolicy = documentLoader()->originalRequest().cachePolicy();
2855         // Back-forward navigations try to load main resource from cache only to avoid re-submitting form data, and start over (with a warning dialog) if that fails.
2856         // This policy is set on initial request too, but should not be inherited.
2857         return (mainDocumentOriginalCachePolicy == ResourceRequestCachePolicy::ReturnCacheDataDontLoad) ? ResourceRequestCachePolicy::ReturnCacheDataElseLoad : mainDocumentOriginalCachePolicy;
2858     }
2859
2860     return ResourceRequestCachePolicy::UseProtocolCachePolicy;
2861 }
2862
2863 void FrameLoader::addExtraFieldsToRequest(ResourceRequest& request, FrameLoadType loadType, bool isMainResource)
2864 {
2865     // If the request came from a previous process due to process-swap-on-navigation then we should not modify the request.
2866     if (m_currentLoadContinuingState == LoadContinuingState::ContinuingWithRequest)
2867         return;
2868
2869     // Don't set the cookie policy URL if it's already been set.
2870     // But make sure to set it on all requests regardless of protocol, as it has significance beyond the cookie policy (<rdar://problem/6616664>).
2871     if (request.firstPartyForCookies().isEmpty()) {
2872         if (isMainResource && m_frame.isMainFrame())
2873             request.setFirstPartyForCookies(request.url());
2874         else if (Document* document = m_frame.document())
2875             request.setFirstPartyForCookies(document->firstPartyForCookies());
2876     }
2877
2878     if (request.isSameSiteUnspecified()) {
2879         auto* initiator = m_frame.document();
2880         if (isMainResource) {
2881             auto* ownerFrame = m_frame.tree().parent();
2882             if (!ownerFrame && m_stateMachine.isDisplayingInitialEmptyDocument())
2883                 ownerFrame = m_opener;
2884             if (ownerFrame)
2885                 initiator = ownerFrame->document();
2886             ASSERT(ownerFrame || m_frame.isMainFrame());
2887         }
2888         addSameSiteInfoToRequestIfNeeded(request, initiator);
2889         request.setIsTopSite(isMainResource && m_frame.isMainFrame());
2890     }
2891
2892     Page* page = frame().page();
2893     bool hasSpecificCachePolicy = request.cachePolicy() != ResourceRequestCachePolicy::UseProtocolCachePolicy;
2894
2895     if (page && page->isResourceCachingDisabled()) {
2896         request.setCachePolicy(ResourceRequestCachePolicy::ReloadIgnoringCacheData);
2897         loadType = FrameLoadType::ReloadFromOrigin;
2898     } else if (!hasSpecificCachePolicy)
2899         request.setCachePolicy(defaultRequestCachingPolicy(request, loadType, isMainResource));
2900
2901     // The remaining modifications are only necessary for HTTP and HTTPS.
2902     if (!request.url().isEmpty() && !request.url().protocolIsInHTTPFamily())
2903         return;
2904
2905     if (!hasSpecificCachePolicy && request.cachePolicy() == ResourceRequestCachePolicy::ReloadIgnoringCacheData) {
2906         if (loadType == FrameLoadType::Reload)
2907             request.setHTTPHeaderField(HTTPHeaderName::CacheControl, "max-age=0");
2908         else if (loadType == FrameLoadType::ReloadFromOrigin) {
2909             request.setHTTPHeaderField(HTTPHeaderName::CacheControl, "no-cache");
2910             request.setHTTPHeaderField(HTTPHeaderName::Pragma, "no-cache");
2911         }
2912     }
2913
2914     if (m_overrideResourceLoadPriorityForTesting)
2915         request.setPriority(m_overrideResourceLoadPriorityForTesting.value());
2916
2917     applyUserAgentIfNeeded(request);
2918
2919     if (isMainResource)
2920         request.setHTTPAccept(defaultAcceptHeader);
2921
2922     // Make sure we send the Origin header.
2923     addHTTPOriginIfNeeded(request, String());
2924
2925     // Only set fallback array if it's still empty (later attempts may be incorrect, see bug 117818).
2926     if (request.responseContentDispositionEncodingFallbackArray().isEmpty()) {
2927         // Always try UTF-8. If that fails, try frame encoding (if any) and then the default.
2928         request.setResponseContentDispositionEncodingFallbackArray("UTF-8", m_frame.document()->encoding(), m_frame.settings().defaultTextEncodingName());
2929     }
2930 }
2931
2932 void FrameLoader::addHTTPOriginIfNeeded(ResourceRequest& request, const String& origin)
2933 {
2934     if (!request.httpOrigin().isEmpty())
2935         return;  // Request already has an Origin header.
2936
2937     // Don't send an Origin header for GET or HEAD to avoid privacy issues.
2938     // For example, if an intranet page has a hyperlink to an external web
2939     // site, we don't want to include the Origin of the request because it
2940     // will leak the internal host name. Similar privacy concerns have lead
2941     // to the widespread suppression of the Referer header at the network
2942     // layer.
2943     if (request.httpMethod() == "GET" || request.httpMethod() == "HEAD")
2944         return;
2945
2946     // For non-GET and non-HEAD methods, always send an Origin header so the
2947     // server knows we support this feature.
2948
2949     if (origin.isEmpty()) {
2950         // If we don't know what origin header to attach, we attach the value
2951         // for an empty origin.
2952         request.setHTTPOrigin(SecurityOrigin::createUnique()->toString());
2953         return;
2954     }
2955
2956     request.setHTTPOrigin(origin);
2957 }
2958
2959 // Implements the "'Same-site' and 'cross-site' Requests" algorithm from <https://tools.ietf.org/html/draft-ietf-httpbis-cookie-same-site-00#section-2.1>.
2960 // The algorithm is ammended to treat URLs that inherit their security origin from their owner (e.g. about:blank)
2961 // as same-site. This matches the behavior of Chrome and Firefox.
2962 void FrameLoader::addSameSiteInfoToRequestIfNeeded(ResourceRequest& request, const Document* initiator)
2963 {
2964     if (!request.isSameSiteUnspecified())
2965         return;
2966     if (!initiator) {
2967         request.setIsSameSite(true);
2968         return;
2969     }
2970     if (SecurityPolicy::shouldInheritSecurityOriginFromOwner(request.url())) {
2971         request.setIsSameSite(true);
2972         return;
2973     }
2974     request.setIsSameSite(registrableDomainsAreEqual(initiator->siteForCookies(), request.url()));
2975 }
2976
2977 void FrameLoader::addHTTPUpgradeInsecureRequestsIfNeeded(ResourceRequest& request)
2978 {
2979     if (request.url().protocolIs("https")) {
2980         // FIXME: Identify HSTS cases and avoid adding the header. <https://bugs.webkit.org/show_bug.cgi?id=157885>
2981         return;
2982     }
2983
2984     request.setHTTPHeaderField(HTTPHeaderName::UpgradeInsecureRequests, "1"_s);
2985 }
2986
2987 void FrameLoader::loadPostRequest(FrameLoadRequest&& request, const String& referrer, FrameLoadType loadType, Event* event, RefPtr<FormState>&& formState, CompletionHandler<void()>&& completionHandler)
2988 {
2989     RELEASE_LOG_IF_ALLOWED("loadPostRequest: frame load started (frame = %p, main = %d)", &m_frame, m_frame.isMainFrame());
2990
2991     String frameName = request.frameName();
2992     LockHistory lockHistory = request.lockHistory();
2993     AllowNavigationToInvalidURL allowNavigationToInvalidURL = request.allowNavigationToInvalidURL();
2994     NewFrameOpenerPolicy openerPolicy = request.newFrameOpenerPolicy();
2995
2996     const ResourceRequest& inRequest = request.resourceRequest();
2997     const URL& url = inRequest.url();
2998     const String& contentType = inRequest.httpContentType();
2999     String origin = inRequest.httpOrigin();
3000
3001     ResourceRequest workingResourceRequest(url);    
3002
3003     if (!referrer.isEmpty())
3004         workingResourceRequest.setHTTPReferrer(referrer);
3005     workingResourceRequest.setHTTPOrigin(origin);
3006     workingResourceRequest.setHTTPMethod("POST");
3007     workingResourceRequest.setHTTPBody(inRequest.httpBody());
3008     workingResourceRequest.setHTTPContentType(contentType);
3009     addExtraFieldsToRequest(workingResourceRequest, loadType, true);
3010
3011     if (Document* document = m_frame.document())
3012         document->contentSecurityPolicy()->upgradeInsecureRequestIfNeeded(workingResourceRequest, ContentSecurityPolicy::InsecureRequestType::Load);
3013
3014     NavigationAction action { request.requester(), workingResourceRequest, request.initiatedByMainFrame(), loadType, true, event, request.shouldOpenExternalURLsPolicy(), request.downloadAttribute() };
3015
3016     if (!frameName.isEmpty()) {
3017         // The search for a target frame is done earlier in the case of form submission.
3018         if (auto* targetFrame = formState ? nullptr : findFrameForNavigation(frameName)) {
3019             targetFrame->loader().loadWithNavigationAction(workingResourceRequest, WTFMove(action), lockHistory, loadType, WTFMove(formState), allowNavigationToInvalidURL, WTFMove(completionHandler));
3020             return;
3021         }
3022
3023         RELEASE_ASSERT(!isBackForwardLoadType(policyChecker().loadType()));
3024         policyChecker().checkNewWindowPolicy(WTFMove(action), WTFMove(workingResourceRequest), WTFMove(formState), frameName, [this, allowNavigationToInvalidURL, openerPolicy, completionHandler = WTFMove(completionHandler)] (const ResourceRequest& request, WeakPtr<FormState>&& formState, const String& frameName, const NavigationAction& action, ShouldContinue shouldContinue) mutable {
3025             continueLoadAfterNewWindowPolicy(request, formState.get(), frameName, action, shouldContinue, allowNavigationToInvalidURL, openerPolicy);
3026             completionHandler();
3027         });
3028         return;
3029     }
3030
3031     // must grab this now, since this load may stop the previous load and clear this flag
3032     bool isRedirect = m_quickRedirectComing;
3033     loadWithNavigationAction(workingResourceRequest, WTFMove(action), lockHistory, loadType, WTFMove(formState), allowNavigationToInvalidURL, [this, isRedirect, protectedFrame = makeRef(m_frame), completionHandler = WTFMove(completionHandler)] () mutable {
3034         if (isRedirect) {
3035             m_quickRedirectComing = false;
3036             if (m_provisionalDocumentLoader)
3037                 m_provisionalDocumentLoader->setIsClientRedirect(true);
3038             else if (m_policyDocumentLoader)
3039                 m_policyDocumentLoader->setIsClientRedirect(true);
3040         }
3041         completionHandler();
3042     });
3043 }
3044
3045 unsigned long FrameLoader::loadResourceSynchronously(const ResourceRequest& request, ClientCredentialPolicy clientCredentialPolicy, const FetchOptions& options, const HTTPHeaderMap& originalRequestHeaders, ResourceError& error, ResourceResponse& response, RefPtr<SharedBuffer>& data)
3046 {
3047     ASSERT(m_frame.document());
3048     String referrer = SecurityPolicy::generateReferrerHeader(m_frame.document()->referrerPolicy(), request.url(), outgoingReferrer());
3049     
3050     ResourceRequest initialRequest = request;
3051     initialRequest.setTimeoutInterval(10);
3052     
3053     if (!referrer.isEmpty())
3054         initialRequest.setHTTPReferrer(referrer);
3055     addHTTPOriginIfNeeded(initialRequest, outgoingOrigin());
3056
3057     initialRequest.setFirstPartyForCookies(m_frame.mainFrame().loader().documentLoader()->request().url());
3058     
3059     addExtraFieldsToSubresourceRequest(initialRequest);
3060
3061     unsigned long identifier = 0;    
3062     ResourceRequest newRequest(initialRequest);
3063     requestFromDelegate(newRequest, identifier, error);
3064
3065 #if ENABLE(CONTENT_EXTENSIONS)
3066     if (error.isNull()) {
3067         if (auto* page = m_frame.page()) {
3068             if (m_documentLoader) {
3069                 auto blockedStatus = page->userContentProvider().processContentExtensionRulesForLoad(newRequest.url(), ResourceType::Raw, *m_documentLoader);
3070                 applyBlockedStatusToRequest(blockedStatus, page, newRequest);
3071                 if (blockedStatus.blockedLoad) {
3072                     newRequest = { };
3073                     error = ResourceError(errorDomainWebKitInternal, 0, initialRequest.url(), emptyString());
3074                     response = { };
3075                     data = nullptr;
3076                 }
3077             }
3078         }
3079     }
3080 #endif
3081
3082     m_frame.document()->contentSecurityPolicy()->upgradeInsecureRequestIfNeeded(newRequest, ContentSecurityPolicy::InsecureRequestType::Load);
3083     
3084     if (error.isNull()) {
3085         ASSERT(!newRequest.isNull());
3086
3087         if (!documentLoader()->applicationCacheHost().maybeLoadSynchronously(newRequest, error, response, data)) {
3088             Vector<char> buffer;
3089             platformStrategies()->loaderStrategy()->loadResourceSynchronously(*this, identifier, newRequest, clientCredentialPolicy, options, originalRequestHeaders, error, response, buffer);
3090             data = SharedBuffer::create(WTFMove(buffer));
3091             documentLoader()->applicationCacheHost().maybeLoadFallbackSynchronously(newRequest, error, response, data);
3092             ResourceLoadObserver::shared().logSubresourceLoading(&m_frame, newRequest, response);
3093         }
3094     }
3095     notifier().sendRemainingDelegateMessages(m_documentLoader.get(), identifier, request, response, data ? data->data() : nullptr, data ? data->size() : 0, -1, error);
3096     return identifier;
3097 }
3098
3099 const ResourceRequest& FrameLoader::originalRequest() const
3100 {
3101     return activeDocumentLoader()->originalRequestCopy();
3102 }
3103
3104 void FrameLoader::receivedMainResourceError(const ResourceError& error)
3105 {
3106     // Retain because the stop may release the last reference to it.
3107     Ref<Frame> protect(m_frame);
3108
3109     RefPtr<DocumentLoader> loader = activeDocumentLoader();
3110     // FIXME: Don't want to do this if an entirely new load is going, so should check
3111     // that both data sources on the frame are either this or nil.
3112     stop();
3113     if (m_client.shouldFallBack(error))
3114         handleFallbackContent();
3115
3116     if (m_state == FrameStateProvisional && m_provisionalDocumentLoader) {
3117         if (m_submittedFormURL == m_provisionalDocumentLoader->originalRequestCopy().url())
3118             m_submittedFormURL = URL();
3119             
3120         // We might have made a page cache item, but now we're bailing out due to an error before we ever
3121         // transitioned to the new page (before WebFrameState == commit).  The goal here is to restore any state
3122         // so that the existing view (that wenever got far enough to replace) can continue being used.
3123         history().invalidateCurrentItemCachedPage();
3124         
3125         // Call clientRedirectCancelledOrFinished here so that the frame load delegate is notified that the redirect's
3126         // status has changed, if there was a redirect. The frame load delegate may have saved some state about
3127         // the redirect in its -webView:willPerformClientRedirectToURL:delay:fireDate:forFrame:. Since we are definitely
3128         // not going to use this provisional resource, as it was cancelled, notify the frame load delegate that the redirect
3129         // has ended.
3130         if (m_sentRedirectNotification)
3131             clientRedirectCancelledOrFinished(NewLoadInProgress::No);
3132     }
3133
3134     checkCompleted();
3135     if (m_frame.page())
3136         checkLoadComplete();
3137 }
3138
3139 void FrameLoader::continueFragmentScrollAfterNavigationPolicy(const ResourceRequest& request, bool shouldContinue)
3140 {
3141     m_quickRedirectComing = false;
3142
3143     if (!shouldContinue)
3144         return;
3145
3146     // Calling stopLoading() on the provisional document loader can cause the underlying
3147     // frame to be deallocated.
3148     Ref<Frame> protectedFrame(m_frame);
3149
3150     // If we have a provisional request for a different document, a fragment scroll should cancel it.
3151     if (m_provisionalDocumentLoader && !equalIgnoringFragmentIdentifier(m_provisionalDocumentLoader->request().url(), request.url())) {
3152         m_provisionalDocumentLoader->stopLoading();
3153         setProvisionalDocumentLoader(nullptr);
3154     }
3155
3156     bool isRedirect = m_quickRedirectComing || policyChecker().loadType() == FrameLoadType::RedirectWithLockedBackForwardList;
3157     loadInSameDocument(request.url(), 0, !isRedirect);
3158 }
3159
3160 bool FrameLoader::shouldPerformFragmentNavigation(bool isFormSubmission, const String& httpMethod, FrameLoadType loadType, const URL& url)
3161 {
3162     // We don't do this if we are submitting a form with method other than "GET", explicitly reloading,
3163     // currently displaying a frameset, or if the URL does not have a fragment.
3164     // These rules were originally based on what KHTML was doing in KHTMLPart::openURL.
3165
3166     // FIXME: What about load types other than Standard and Reload?
3167
3168     return (!isFormSubmission || equalLettersIgnoringASCIICase(httpMethod, "get"))
3169         && !isReload(loadType)
3170         && loadType != FrameLoadType::Same
3171         && m_frame.document()->pageCacheState() != Document::InPageCache
3172         && !shouldReload(m_frame.document()->url(), url)
3173         // We don't want to just scroll if a link from within a
3174         // frameset is trying to reload the frameset into _top.
3175         && !m_frame.document()->isFrameSet();
3176 }
3177
3178 static bool itemAllowsScrollRestoration(HistoryItem* historyItem)
3179 {
3180     return !historyItem || historyItem->shouldRestoreScrollPosition();
3181 }
3182
3183 static bool isSameDocumentReload(bool isNewNavigation, FrameLoadType loadType)
3184 {
3185     return !isNewNavigation && !isBackForwardLoadType(loadType);
3186 }
3187
3188 void FrameLoader::scrollToFragmentWithParentBoundary(const URL& url, bool isNewNavigation)
3189 {
3190     FrameView* view = m_frame.view();
3191     if (!view)
3192         return;
3193
3194     if (isSameDocumentReload(isNewNavigation, m_loadType) || itemAllowsScrollRestoration(history().currentItem()))
3195         view->scrollToFragment(url);
3196 }
3197
3198 bool FrameLoader::shouldClose()
3199 {
3200     Page* page = m_frame.page();
3201     if (!page)
3202         return true;
3203     if (!page->chrome().canRunBeforeUnloadConfirmPanel())
3204         return true;
3205
3206     // Store all references to each subframe in advance since beforeunload's event handler may modify frame
3207     Vector<Ref<Frame>, 16> targetFrames;
3208     targetFrames.append(m_frame);
3209     for (Frame* child = m_frame.tree().firstChild(); child; child = child->tree().traverseNext(&m_frame))
3210         targetFrames.append(*child);
3211
3212     bool shouldClose = false;
3213     {
3214         NavigationDisabler navigationDisabler(&m_frame);
3215         IgnoreOpensDuringUnloadCountIncrementer ignoreOpensDuringUnloadCountIncrementer(m_frame.document());
3216         size_t i;
3217
3218         for (i = 0; i < targetFrames.size(); i++) {
3219             if (!targetFrames[i]->tree().isDescendantOf(&m_frame))
3220                 continue;
3221             if (!targetFrames[i]->loader().dispatchBeforeUnloadEvent(page->chrome(), this))
3222                 break;
3223         }
3224
3225         if (i == targetFrames.size())
3226             shouldClose = true;
3227     }
3228
3229     if (!shouldClose)
3230         m_submittedFormURL = URL();
3231
3232     m_currentNavigationHasShownBeforeUnloadConfirmPanel = false;
3233     return shouldClose;
3234 }
3235
3236 void FrameLoader::dispatchUnloadEvents(UnloadEventPolicy unloadEventPolicy)
3237 {
3238     if (!m_frame.document())
3239         return;
3240
3241     // We store the frame's page in a local variable because the frame might get detached inside dispatchEvent.
3242     ForbidPromptsScope forbidPrompts(m_frame.page());
3243     IgnoreOpensDuringUnloadCountIncrementer ignoreOpensDuringUnloadCountIncrementer(m_frame.document());
3244
3245     if (m_didCallImplicitClose && !m_wasUnloadEventEmitted) {
3246         auto* currentFocusedElement = m_frame.document()->focusedElement();
3247         if (is<HTMLInputElement>(currentFocusedElement))
3248             downcast<HTMLInputElement>(*currentFocusedElement).endEditing();
3249         if (m_pageDismissalEventBeingDispatched == PageDismissalType::None) {
3250             if (unloadEventPolicy == UnloadEventPolicyUnloadAndPageHide) {
3251                 m_pageDismissalEventBeingDispatched = PageDismissalType::PageHide;
3252                 m_frame.document()->domWindow()->dispatchEvent(PageTransitionEvent::create(eventNames().pagehideEvent, m_frame.document()->pageCacheState() == Document::AboutToEnterPageCache), m_frame.document());
3253             }
3254
3255             // FIXME: update Page Visibility state here.
3256             // https://bugs.webkit.org/show_bug.cgi?id=116770
3257
3258             if (m_frame.document()->pageCacheState() == Document::NotInPageCache) {
3259                 Ref<Event> unloadEvent(Event::create(eventNames().unloadEvent, Event::CanBubble::No, Event::IsCancelable::No));
3260                 // The DocumentLoader (and thus its LoadTiming) might get destroyed
3261                 // while dispatching the event, so protect it to prevent writing the end
3262                 // time into freed memory.
3263                 RefPtr<DocumentLoader> documentLoader = m_provisionalDocumentLoader;
3264                 m_pageDismissalEventBeingDispatched = PageDismissalType::Unload;
3265                 if (documentLoader && documentLoader->timing().startTime() && !documentLoader->timing().unloadEventStart() && !documentLoader->timing().unloadEventEnd()) {
3266                     auto& timing = documentLoader->timing();
3267                     timing.markUnloadEventStart();
3268                     m_frame.document()->domWindow()->dispatchEvent(unloadEvent, m_frame.document());
3269                     timing.markUnloadEventEnd();
3270                 } else
3271                     m_frame.document()->domWindow()->dispatchEvent(unloadEvent, m_frame.document());
3272             }
3273         }
3274         m_pageDismissalEventBeingDispatched = PageDismissalType::None;
3275         m_wasUnloadEventEmitted = true;
3276     }
3277
3278     // Dispatching the unload event could have made m_frame.document() null.
3279     if (!m_frame.document())
3280         return;
3281
3282     if (m_frame.document()->pageCacheState() != Document::NotInPageCache)
3283         return;
3284
3285     // Don't remove event listeners from a transitional empty document (see bug 28716 for more information).
3286     bool keepEventListeners = m_stateMachine.isDisplayingInitialEmptyDocument() && m_provisionalDocumentLoader
3287         && m_frame.document()->isSecureTransitionTo(m_provisionalDocumentLoader->url());
3288
3289     if (!keepEventListeners)
3290         m_frame.document()->removeAllEventListeners();
3291 }
3292
3293 static bool shouldAskForNavigationConfirmation(Document& document, const BeforeUnloadEvent& event)
3294 {
3295     // Confirmation dialog should not be displayed when the allow-modals flag is not set.
3296     if (document.isSandboxed(SandboxModals))
3297         return false;
3298
3299     bool userDidInteractWithPage = document.topDocument().userDidInteractWithPage();
3300     // Web pages can request we ask for confirmation before navigating by:
3301     // - Cancelling the BeforeUnloadEvent (modern way)
3302     // - Setting the returnValue attribute on the BeforeUnloadEvent to a non-empty string.
3303     // - Returning a non-empty string from the event handler, which is then set as returnValue
3304     //   attribute on the BeforeUnloadEvent.
3305     return userDidInteractWithPage && (event.defaultPrevented() || !event.returnValue().isEmpty());
3306 }
3307
3308 bool FrameLoader::dispatchBeforeUnloadEvent(Chrome& chrome, FrameLoader* frameLoaderBeingNavigated)
3309 {
3310     DOMWindow* domWindow = m_frame.document()->domWindow();
3311     if (!domWindow)
3312         return true;
3313
3314     RefPtr<Document> document = m_frame.document();
3315     if (!document->bodyOrFrameset())
3316         return true;
3317     
3318     Ref<BeforeUnloadEvent> beforeUnloadEvent = BeforeUnloadEvent::create();
3319     m_pageDismissalEventBeingDispatched = PageDismissalType::BeforeUnload;
3320
3321     {
3322         ForbidPromptsScope forbidPrompts(m_frame.page());
3323         domWindow->dispatchEvent(beforeUnloadEvent, domWindow->document());
3324     }
3325
3326     m_pageDismissalEventBeingDispatched = PageDismissalType::None;
3327
3328     if (!beforeUnloadEvent->defaultPrevented())
3329         document->defaultEventHandler(beforeUnloadEvent.get());
3330
3331     if (!shouldAskForNavigationConfirmation(*document, beforeUnloadEvent))
3332         return true;
3333
3334     // If the navigating FrameLoader has already shown a beforeunload confirmation panel for the current navigation attempt,
3335     // this frame is not allowed to cause another one to be shown.
3336     if (frameLoaderBeingNavigated->m_currentNavigationHasShownBeforeUnloadConfirmPanel) {
3337         document->addConsoleMessage(MessageSource::JS, MessageLevel::Error, "Blocked attempt to show multiple beforeunload confirmation dialogs for the same navigation."_s);
3338         return true;
3339     }
3340
3341     // We should only display the beforeunload dialog for an iframe if its SecurityOrigin matches all
3342     // ancestor frame SecurityOrigins up through the navigating FrameLoader.
3343     if (frameLoaderBeingNavigated != this) {
3344         Frame* parentFrame = m_frame.tree().parent();
3345         while (parentFrame) {
3346             Document* parentDocument = parentFrame->document();
3347             if (!parentDocument)
3348                 return true;
3349             if (!m_frame.document() || !m_frame.document()->securityOrigin().canAccess(parentDocument->securityOrigin())) {
3350                 document->addConsoleMessage(MessageSource::JS, MessageLevel::Error, "Blocked attempt to show beforeunload confirmation dialog on behalf of a frame with different security origin. Protocols, domains, and ports must match."_s);
3351                 return true;
3352             }
3353             
3354             if (&parentFrame->loader() == frameLoaderBeingNavigated)
3355                 break;
3356             
3357             parentFrame = parentFrame->tree().parent();
3358         }
3359         
3360         // The navigatingFrameLoader should always be in our ancestory.
3361         ASSERT(parentFrame);
3362         ASSERT(&parentFrame->loader() == frameLoaderBeingNavigated);
3363     }
3364
3365     frameLoaderBeingNavigated->m_currentNavigationHasShownBeforeUnloadConfirmPanel = true;
3366
3367     String text = document->displayStringModifiedByEncoding(beforeUnloadEvent->returnValue());
3368     return chrome.runBeforeUnloadConfirmPanel(text, m_frame);
3369 }
3370
3371 void FrameLoader::continueLoadAfterNavigationPolicy(const ResourceRequest& request, FormState* formState, NavigationPolicyDecision navigationPolicyDecision, AllowNavigationToInvalidURL allowNavigationToInvalidURL)
3372 {
3373     // If we loaded an alternate page to replace an unreachableURL, we'll get in here with a
3374     // nil policyDataSource because loading the alternate page will have passed
3375     // through this method already, nested; otherwise, policyDataSource should still be set.
3376     ASSERT(m_policyDocumentLoader || !m_provisionalDocumentLoader->unreachableURL().isEmpty());
3377
3378     bool isTargetItem = history().provisionalItem() ? history().provisionalItem()->isTargetItem() : false;
3379
3380     bool urlIsDisallowed = allowNavigationToInvalidURL == AllowNavigationToInvalidURL::No && !request.url().isValid();
3381     bool canContinue = navigationPolicyDecision == NavigationPolicyDecision::ContinueLoad && shouldClose() && !urlIsDisallowed;
3382
3383     if (!canContinue) {
3384         RELEASE_LOG_IF_ALLOWED("continueLoadAfterNavigationPolicy: can't continue loading frame due to the following reasons ("
3385             "frame = %p, "
3386             "main = %d, "
3387             "allowNavigationToInvalidURL = %d, "
3388             "requestURLIsValid = %d, "
3389             "navigationPolicyDecision = %d)",
3390             &m_frame,
3391             m_frame.isMainFrame(),
3392             static_cast<int>(allowNavigationToInvalidURL),
3393             request.url().isValid(),
3394             static_cast<int>(navigationPolicyDecision));
3395
3396         // If we were waiting for a quick redirect, but the policy delegate decided to ignore it, then we 
3397         // need to report that the client redirect was cancelled.
3398         // FIXME: The client should be told about ignored non-quick redirects, too.
3399         if (m_quickRedirectComing)
3400             clientRedirectCancelledOrFinished(NewLoadInProgress::No);
3401
3402         if (navigationPolicyDecision == NavigationPolicyDecision::StopAllLoads) {
3403             stopAllLoaders();
3404             m_checkTimer.stop();
3405         }
3406
3407         setPolicyDocumentLoader(nullptr);
3408         checkCompleted();