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