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