Add initial support for 'Cross-Origin-Options' HTTP response header
[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, bool isSystemPreview)
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, isSystemPreview), 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()), referrer(), 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         if (m_frame.settings().crossOriginOptionsSupportEnabled()) {
747             String crossOriginOptionsHeader = m_documentLoader->response().httpHeaderField(HTTPHeaderName::CrossOriginOptions);
748             if (!crossOriginOptionsHeader.isEmpty())
749                 m_frame.document()->setCrossOriginOptions(parseCrossOriginOptionsHeader(crossOriginOptionsHeader));
750         }
751     }
752
753     history().restoreDocumentState();
754 }
755
756 void FrameLoader::finishedParsing()
757 {
758     LOG(Loading, "WebCoreLoading %s: Finished parsing", m_frame.tree().uniqueName().string().utf8().data());
759
760     m_frame.injectUserScripts(InjectAtDocumentEnd);
761
762     if (m_stateMachine.creatingInitialEmptyDocument())
763         return;
764
765     // This can be called from the Frame's destructor, in which case we shouldn't protect ourselves
766     // because doing so will cause us to re-enter the destructor when protector goes out of scope.
767     // Null-checking the FrameView indicates whether or not we're in the destructor.
768     RefPtr<Frame> protector = m_frame.view() ? &m_frame : 0;
769
770     m_client.dispatchDidFinishDocumentLoad();
771
772     scrollToFragmentWithParentBoundary(m_frame.document()->url());
773
774     checkCompleted();
775
776     if (!m_frame.view())
777         return; // We are being destroyed by something checkCompleted called.
778
779     // Check if the scrollbars are really needed for the content.
780     // If not, remove them, relayout, and repaint.
781     m_frame.view()->restoreScrollbar();
782 }
783
784 void FrameLoader::loadDone()
785 {
786     checkCompleted();
787 }
788
789 bool FrameLoader::allChildrenAreComplete() const
790 {
791     for (Frame* child = m_frame.tree().firstChild(); child; child = child->tree().nextSibling()) {
792         if (!child->loader().m_isComplete)
793             return false;
794     }
795     return true;
796 }
797
798 bool FrameLoader::allAncestorsAreComplete() const
799 {
800     for (Frame* ancestor = &m_frame; ancestor; ancestor = ancestor->tree().parent()) {
801         if (!ancestor->loader().m_isComplete)
802             return false;
803     }
804     return true;
805 }
806
807 void FrameLoader::checkCompleted()
808 {
809     m_shouldCallCheckCompleted = false;
810
811     // Have we completed before?
812     if (m_isComplete)
813         return;
814     
815     // FIXME: Remove this code once https://webkit.org/b/185284 is fixed.
816     if (HTMLMediaElement::isRunningDestructor()) {
817         ASSERT_NOT_REACHED();
818         scheduleCheckCompleted();
819         return;
820     }
821
822     // FIXME: It would be better if resource loads were kicked off after render tree update (or didn't complete synchronously).
823     //        https://bugs.webkit.org/show_bug.cgi?id=171729
824     if (m_frame.document()->inRenderTreeUpdate()) {
825         scheduleCheckCompleted();
826         return;
827     }
828
829     // Are we still parsing?
830     if (m_frame.document()->parsing())
831         return;
832
833     // Still waiting for images/scripts?
834     if (m_frame.document()->cachedResourceLoader().requestCount())
835         return;
836
837     // Still waiting for elements that don't go through a FrameLoader?
838     if (m_frame.document()->isDelayingLoadEvent())
839         return;
840
841     auto* scriptableParser = m_frame.document()->scriptableDocumentParser();
842     if (scriptableParser && scriptableParser->hasScriptsWaitingForStylesheets())
843         return;
844
845     // Any frame that hasn't completed yet?
846     if (!allChildrenAreComplete())
847         return;
848
849     // Important not to protect earlier in this function, because earlier parts
850     // of this function can be called in the frame's destructor, and it's not legal
851     // to ref an object while it's being destroyed.
852     Ref<Frame> protect(m_frame);
853
854     // OK, completed.
855     m_isComplete = true;
856     m_requestedHistoryItem = nullptr;
857     m_frame.document()->setReadyState(Document::Complete);
858
859 #if PLATFORM(IOS)
860     if (m_frame.document()->url().isEmpty()) {
861         // We need to update the document URL of a PDF document to be non-empty so that both back/forward history navigation
862         // between PDF pages and fragment navigation works. See <rdar://problem/9544769> for more details.
863         // FIXME: Is there a better place for this code, say DocumentLoader? Also, we should explicitly only update the URL
864         // of the document when it's a PDFDocument object instead of assuming that a Document object with an empty URL is a PDFDocument.
865         // FIXME: This code is incorrect for a synthesized document (which also has an empty URL). The URL for a synthesized
866         // document should be the URL specified to FrameLoader::initForSynthesizedDocument().
867         m_frame.document()->setURL(activeDocumentLoader()->documentURL());
868     }
869 #endif
870
871     checkCallImplicitClose(); // if we didn't do it before
872
873     m_frame.navigationScheduler().startTimer();
874
875     completed();
876     if (m_frame.page())
877         checkLoadComplete();
878 }
879
880 void FrameLoader::checkTimerFired()
881 {
882     Ref<Frame> protect(m_frame);
883
884     if (Page* page = m_frame.page()) {
885         if (page->defersLoading())
886             return;
887     }
888     if (m_shouldCallCheckCompleted)
889         checkCompleted();
890     if (m_shouldCallCheckLoadComplete)
891         checkLoadComplete();
892 }
893
894 void FrameLoader::startCheckCompleteTimer()
895 {
896     if (!(m_shouldCallCheckCompleted || m_shouldCallCheckLoadComplete))
897         return;
898     if (m_checkTimer.isActive())
899         return;
900     m_checkTimer.startOneShot(0_s);
901 }
902
903 void FrameLoader::scheduleCheckCompleted()
904 {
905     m_shouldCallCheckCompleted = true;
906     startCheckCompleteTimer();
907 }
908
909 void FrameLoader::scheduleCheckLoadComplete()
910 {
911     m_shouldCallCheckLoadComplete = true;
912     startCheckCompleteTimer();
913 }
914
915 void FrameLoader::checkCallImplicitClose()
916 {
917     if (m_didCallImplicitClose || m_frame.document()->parsing() || m_frame.document()->isDelayingLoadEvent())
918         return;
919
920     if (!allChildrenAreComplete())
921         return; // still got a frame running -> too early
922
923     m_didCallImplicitClose = true;
924     m_wasUnloadEventEmitted = false;
925     m_frame.document()->implicitClose();
926 }
927
928 void FrameLoader::loadURLIntoChildFrame(const URL& url, const String& referer, Frame* childFrame)
929 {
930     ASSERT(childFrame);
931
932 #if ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
933     if (auto activeLoader = activeDocumentLoader()) {
934         if (auto subframeArchive = activeLoader->popArchiveForSubframe(childFrame->tree().uniqueName(), url)) {
935             childFrame->loader().loadArchive(RefPtr<Archive> { subframeArchive }.releaseNonNull());
936             return;
937         }
938     }
939 #endif
940
941     // If we're moving in the back/forward list, we might want to replace the content
942     // of this child frame with whatever was there at that point.
943     auto* parentItem = history().currentItem();
944     if (parentItem && parentItem->children().size() && isBackForwardLoadType(loadType()) && !m_frame.document()->loadEventFinished()) {
945         if (auto* childItem = parentItem->childItemWithTarget(childFrame->tree().uniqueName())) {
946             childFrame->loader().m_requestedHistoryItem = childItem;
947             childFrame->loader().loadDifferentDocumentItem(*childItem, loadType(), MayAttemptCacheOnlyLoadForFormSubmissionItem, NavigationPolicyCheck::Require);
948             return;
949         }
950     }
951
952     auto* lexicalFrame = lexicalFrameFromCommonVM();
953     auto initiatedByMainFrame = lexicalFrame && lexicalFrame->isMainFrame() ? InitiatedByMainFrame::Yes : InitiatedByMainFrame::Unknown;
954
955     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 };
956     childFrame->loader().loadURL(WTFMove(frameLoadRequest), referer, FrameLoadType::RedirectWithLockedBackForwardList, nullptr, nullptr, [] { });
957 }
958
959 #if ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
960
961 void FrameLoader::loadArchive(Ref<Archive>&& archive)
962 {
963     ArchiveResource* mainResource = archive->mainResource();
964     ASSERT(mainResource);
965     if (!mainResource)
966         return;
967
968     ResourceResponse response(URL(), mainResource->mimeType(), mainResource->data().size(), mainResource->textEncoding());
969     SubstituteData substituteData(&mainResource->data(), URL(), response, SubstituteData::SessionHistoryVisibility::Hidden);
970     
971     ResourceRequest request(mainResource->url());
972
973     auto documentLoader = m_client.createDocumentLoader(request, substituteData);
974     documentLoader->setArchive(WTFMove(archive));
975     load(documentLoader.ptr());
976 }
977
978 #endif // ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
979
980 String FrameLoader::outgoingReferrer() const
981 {
982     // See http://www.whatwg.org/specs/web-apps/current-work/#fetching-resources
983     // for why we walk the parent chain for srcdoc documents.
984     Frame* frame = &m_frame;
985     while (frame && frame->document()->isSrcdocDocument()) {
986         frame = frame->tree().parent();
987         // Srcdoc documents cannot be top-level documents, by definition,
988         // because they need to be contained in iframes with the srcdoc.
989         ASSERT(frame);
990     }
991     if (!frame)
992         return emptyString();
993     return frame->loader().m_outgoingReferrer;
994 }
995
996 String FrameLoader::outgoingOrigin() const
997 {
998     return m_frame.document()->securityOrigin().toString();
999 }
1000
1001 bool FrameLoader::checkIfFormActionAllowedByCSP(const URL& url, bool didReceiveRedirectResponse) const
1002 {
1003     if (m_submittedFormURL.isEmpty())
1004         return true;
1005
1006     auto redirectResponseReceived = didReceiveRedirectResponse ? ContentSecurityPolicy::RedirectResponseReceived::Yes : ContentSecurityPolicy::RedirectResponseReceived::No;
1007     return m_frame.document()->contentSecurityPolicy()->allowFormAction(url, redirectResponseReceived);
1008 }
1009
1010 Frame* FrameLoader::opener()
1011 {
1012     return m_opener;
1013 }
1014
1015 void FrameLoader::setOpener(Frame* opener)
1016 {
1017     if (m_opener && !opener)
1018         m_client.didDisownOpener();
1019
1020     if (m_opener) {
1021         // When setOpener is called in ~FrameLoader, opener's m_frameLoader is already cleared.
1022         auto& openerFrameLoader = m_opener == &m_frame ? *this : m_opener->loader();
1023         openerFrameLoader.m_openedFrames.remove(&m_frame);
1024     }
1025     if (opener)
1026         opener->loader().m_openedFrames.add(&m_frame);
1027     m_opener = opener;
1028
1029     if (m_frame.document())
1030         m_frame.document()->initSecurityContext();
1031 }
1032
1033 // FIXME: This does not belong in FrameLoader!
1034 void FrameLoader::handleFallbackContent()
1035 {
1036     HTMLFrameOwnerElement* owner = m_frame.ownerElement();
1037     if (!is<HTMLObjectElement>(owner))
1038         return;
1039     downcast<HTMLObjectElement>(*owner).renderFallbackContent();
1040 }
1041
1042 void FrameLoader::provisionalLoadStarted()
1043 {
1044     if (m_stateMachine.firstLayoutDone())
1045         m_stateMachine.advanceTo(FrameLoaderStateMachine::CommittedFirstRealLoad);
1046     m_frame.navigationScheduler().cancel(true);
1047     m_client.provisionalLoadStarted();
1048
1049     if (m_frame.isMainFrame()) {
1050         tracePoint(MainResourceLoadDidStartProvisional);
1051
1052         if (auto* page = m_frame.page())
1053             page->didStartProvisionalLoad();
1054     }
1055 }
1056
1057 void FrameLoader::resetMultipleFormSubmissionProtection()
1058 {
1059     m_submittedFormURL = URL();
1060 }
1061
1062 void FrameLoader::updateFirstPartyForCookies()
1063 {
1064     if (m_frame.tree().parent())
1065         setFirstPartyForCookies(m_frame.tree().parent()->document()->firstPartyForCookies());
1066     else
1067         setFirstPartyForCookies(m_frame.document()->url());
1068 }
1069
1070 void FrameLoader::setFirstPartyForCookies(const URL& url)
1071 {
1072     for (Frame* frame = &m_frame; frame; frame = frame->tree().traverseNext(&m_frame))
1073         frame->document()->setFirstPartyForCookies(url);
1074
1075     String registrableDomain = ResourceRequest::partitionName(url.host());
1076     for (Frame* frame = &m_frame; frame; frame = frame->tree().traverseNext(&m_frame)) {
1077         if (SecurityPolicy::shouldInheritSecurityOriginFromOwner(frame->document()->url()) || registrableDomainsAreEqual(frame->document()->url(), registrableDomain))
1078             frame->document()->setFirstPartyForSameSiteCookies(url);
1079     }
1080 }
1081
1082 // This does the same kind of work that didOpenURL does, except it relies on the fact
1083 // that a higher level already checked that the URLs match and the scrolling is the right thing to do.
1084 void FrameLoader::loadInSameDocument(const URL& url, SerializedScriptValue* stateObject, bool isNewNavigation)
1085 {
1086     // If we have a state object, we cannot also be a new navigation.
1087     ASSERT(!stateObject || (stateObject && !isNewNavigation));
1088
1089     // Update the data source's request with the new URL to fake the URL change
1090     URL oldURL = m_frame.document()->url();
1091     m_frame.document()->setURL(url);
1092     setOutgoingReferrer(url);
1093     documentLoader()->replaceRequestURLForSameDocumentNavigation(url);
1094     if (isNewNavigation && !shouldTreatURLAsSameAsCurrent(url) && !stateObject) {
1095         // NB: must happen after replaceRequestURLForSameDocumentNavigation(), since we add 
1096         // based on the current request. Must also happen before we openURL and displace the 
1097         // scroll position, since adding the BF item will save away scroll state.
1098         
1099         // NB2: If we were loading a long, slow doc, and the user fragment navigated before
1100         // it was done, currItem is now set the that slow doc, and prevItem is whatever was
1101         // before it.  Adding the b/f item will bump the slow doc down to prevItem, even
1102         // though its load is not yet done.  I think this all works out OK, for one because
1103         // we have already saved away the scroll and doc state for the long slow load,
1104         // but it's not an obvious case.
1105
1106         history().updateBackForwardListForFragmentScroll();
1107     }
1108     
1109     bool hashChange = equalIgnoringFragmentIdentifier(url, oldURL) && url.fragmentIdentifier() != oldURL.fragmentIdentifier();
1110     
1111     history().updateForSameDocumentNavigation();
1112
1113     // If we were in the autoscroll/panScroll mode we want to stop it before following the link to the anchor
1114     if (hashChange)
1115         m_frame.eventHandler().stopAutoscrollTimer();
1116     
1117     // It's important to model this as a load that starts and immediately finishes.
1118     // Otherwise, the parent frame may think we never finished loading.
1119     started();
1120
1121     // We need to scroll to the fragment whether or not a hash change occurred, since
1122     // the user might have scrolled since the previous navigation.
1123     scrollToFragmentWithParentBoundary(url, isNewNavigation);
1124     
1125     m_isComplete = false;
1126     checkCompleted();
1127
1128     if (isNewNavigation) {
1129         // This will clear previousItem from the rest of the frame tree that didn't
1130         // doing any loading. We need to make a pass on this now, since for fragment
1131         // navigation we'll not go through a real load and reach Completed state.
1132         checkLoadComplete();
1133     }
1134
1135     m_client.dispatchDidNavigateWithinPage();
1136
1137     m_frame.document()->statePopped(stateObject ? Ref<SerializedScriptValue> { *stateObject } : SerializedScriptValue::nullValue());
1138     m_client.dispatchDidPopStateWithinPage();
1139     
1140     if (hashChange) {
1141         m_frame.document()->enqueueHashchangeEvent(oldURL, url);
1142         m_client.dispatchDidChangeLocationWithinPage();
1143     }
1144     
1145     // FrameLoaderClient::didFinishLoad() tells the internal load delegate the load finished with no error
1146     m_client.didFinishLoad();
1147 }
1148
1149 bool FrameLoader::isComplete() const
1150 {
1151     return m_isComplete;
1152 }
1153
1154 void FrameLoader::completed()
1155 {
1156     Ref<Frame> protect(m_frame);
1157
1158     for (Frame* descendant = m_frame.tree().traverseNext(&m_frame); descendant; descendant = descendant->tree().traverseNext(&m_frame))
1159         descendant->navigationScheduler().startTimer();
1160
1161     if (Frame* parent = m_frame.tree().parent())
1162         parent->loader().checkCompleted();
1163
1164     if (m_frame.view())
1165         m_frame.view()->maintainScrollPositionAtAnchor(nullptr);
1166 }
1167
1168 void FrameLoader::started()
1169 {
1170     for (Frame* frame = &m_frame; frame; frame = frame->tree().parent())
1171         frame->loader().m_isComplete = false;
1172 }
1173
1174 void FrameLoader::prepareForLoadStart()
1175 {
1176     RELEASE_LOG_IF_ALLOWED("prepareForLoadStart: Starting frame load (frame = %p, main = %d)", &m_frame, m_frame.isMainFrame());
1177
1178     m_progressTracker->progressStarted();
1179     m_client.dispatchDidStartProvisionalLoad();
1180
1181     if (AXObjectCache::accessibilityEnabled()) {
1182         if (AXObjectCache* cache = m_frame.document()->existingAXObjectCache()) {
1183             AXObjectCache::AXLoadingEvent loadingEvent = loadType() == FrameLoadType::Reload ? AXObjectCache::AXLoadingReloaded : AXObjectCache::AXLoadingStarted;
1184             cache->frameLoadingEventNotification(&m_frame, loadingEvent);
1185         }
1186     }
1187 }
1188
1189 void FrameLoader::setupForReplace()
1190 {
1191     m_client.revertToProvisionalState(m_documentLoader.get());
1192     setState(FrameStateProvisional);
1193     m_provisionalDocumentLoader = m_documentLoader;
1194     m_documentLoader = nullptr;
1195     detachChildren();
1196 }
1197
1198 void FrameLoader::loadFrameRequest(FrameLoadRequest&& request, Event* event, FormState* formState)
1199 {
1200     // Protect frame from getting blown away inside dispatchBeforeLoadEvent in loadWithDocumentLoader.
1201     auto protectFrame = makeRef(m_frame);
1202
1203     URL url = request.resourceRequest().url();
1204
1205     ASSERT(m_frame.document());
1206     if (!request.requesterSecurityOrigin().canDisplay(url)) {
1207         reportLocalLoadFailed(&m_frame, url.stringCenterEllipsizedToLength());
1208         return;
1209     }
1210
1211     String argsReferrer = request.resourceRequest().httpReferrer();
1212     if (argsReferrer.isEmpty())
1213         argsReferrer = outgoingReferrer();
1214
1215     String referrer = SecurityPolicy::generateReferrerHeader(m_frame.document()->referrerPolicy(), url, argsReferrer);
1216     if (request.shouldSendReferrer() == NeverSendReferrer)
1217         referrer = String();
1218
1219     FrameLoadType loadType;
1220     if (request.resourceRequest().cachePolicy() == ReloadIgnoringCacheData)
1221         loadType = FrameLoadType::Reload;
1222     else if (request.lockBackForwardList() == LockBackForwardList::Yes)
1223         loadType = FrameLoadType::RedirectWithLockedBackForwardList;
1224     else
1225         loadType = FrameLoadType::Standard;
1226
1227     auto completionHandler = [this, protectedFrame = makeRef(m_frame), formState = makeRefPtr(formState), frameName = request.frameName()] {
1228         // FIXME: It's possible this targetFrame will not be the same frame that was targeted by the actual
1229         // load if frame names have changed.
1230         Frame* sourceFrame = formState ? formState->sourceDocument().frame() : &m_frame;
1231         if (!sourceFrame)
1232             sourceFrame = &m_frame;
1233         Frame* targetFrame = sourceFrame->loader().findFrameForNavigation(frameName);
1234         if (targetFrame && targetFrame != sourceFrame) {
1235             if (Page* page = targetFrame->page())
1236                 page->chrome().focus();
1237         }
1238     };
1239
1240     if (request.resourceRequest().httpMethod() == "POST")
1241         loadPostRequest(WTFMove(request), referrer, loadType, event, formState, WTFMove(completionHandler));
1242     else
1243         loadURL(WTFMove(request), referrer, loadType, event, formState, WTFMove(completionHandler));
1244 }
1245
1246 static ShouldOpenExternalURLsPolicy shouldOpenExternalURLsPolicyToApply(Frame& currentFrame, InitiatedByMainFrame initiatedByMainFrame, ShouldOpenExternalURLsPolicy propagatedPolicy)
1247 {
1248     if (UserGestureIndicator::processingUserGesture())
1249         return ShouldOpenExternalURLsPolicy::ShouldAllow;
1250
1251     if (initiatedByMainFrame == InitiatedByMainFrame::Yes)
1252         return propagatedPolicy;
1253
1254     if (!currentFrame.isMainFrame())
1255         return ShouldOpenExternalURLsPolicy::ShouldNotAllow;
1256
1257     return propagatedPolicy;
1258 }
1259
1260 static ShouldOpenExternalURLsPolicy shouldOpenExternalURLsPolicyToApply(Frame& currentFrame, const FrameLoadRequest& frameLoadRequest)
1261 {
1262     return shouldOpenExternalURLsPolicyToApply(currentFrame, frameLoadRequest.initiatedByMainFrame(), frameLoadRequest.shouldOpenExternalURLsPolicy());
1263 }
1264
1265 static void applyShouldOpenExternalURLsPolicyToNewDocumentLoader(Frame& frame, DocumentLoader& documentLoader, InitiatedByMainFrame initiatedByMainFrame, ShouldOpenExternalURLsPolicy propagatedPolicy)
1266 {
1267     documentLoader.setShouldOpenExternalURLsPolicy(shouldOpenExternalURLsPolicyToApply(frame, initiatedByMainFrame, propagatedPolicy));
1268 }
1269
1270 static void applyShouldOpenExternalURLsPolicyToNewDocumentLoader(Frame& frame, DocumentLoader& documentLoader, const FrameLoadRequest& frameLoadRequest)
1271 {
1272     documentLoader.setShouldOpenExternalURLsPolicy(shouldOpenExternalURLsPolicyToApply(frame, frameLoadRequest));
1273 }
1274
1275 bool FrameLoader::isNavigationAllowed() const
1276 {
1277     return m_pageDismissalEventBeingDispatched == PageDismissalType::None && NavigationDisabler::isNavigationAllowed(m_frame);
1278 }
1279
1280 bool FrameLoader::isStopLoadingAllowed() const
1281 {
1282     return m_pageDismissalEventBeingDispatched == PageDismissalType::None;
1283 }
1284
1285 void FrameLoader::loadURL(FrameLoadRequest&& frameLoadRequest, const String& referrer, FrameLoadType newLoadType, Event* event, FormState* formState, CompletionHandler<void()>&& completionHandler)
1286 {
1287     CompletionHandlerCallingScope completionHandlerCaller(WTFMove(completionHandler));
1288     if (m_inStopAllLoaders)
1289         return;
1290
1291     Ref<Frame> protect(m_frame);
1292
1293     String frameName = frameLoadRequest.frameName();
1294     AllowNavigationToInvalidURL allowNavigationToInvalidURL = frameLoadRequest.allowNavigationToInvalidURL();
1295     NewFrameOpenerPolicy openerPolicy = frameLoadRequest.newFrameOpenerPolicy();
1296     LockHistory lockHistory = frameLoadRequest.lockHistory();
1297     bool isFormSubmission = formState;
1298
1299     const URL& newURL = frameLoadRequest.resourceRequest().url();
1300     ResourceRequest request(newURL);
1301     if (!referrer.isEmpty()) {
1302         request.setHTTPReferrer(referrer);
1303         RefPtr<SecurityOrigin> referrerOrigin = SecurityOrigin::createFromString(referrer);
1304         addHTTPOriginIfNeeded(request, referrerOrigin->toString());
1305     }
1306     if (&m_frame.tree().top() != &m_frame)
1307         request.setDomainForCachePartition(m_frame.tree().top().document()->domainForCachePartition());
1308
1309     addExtraFieldsToRequest(request, newLoadType, true);
1310     if (isReload(newLoadType))
1311         request.setCachePolicy(ReloadIgnoringCacheData);
1312
1313     ASSERT(newLoadType != FrameLoadType::Same);
1314
1315     // The search for a target frame is done earlier in the case of form submission.
1316     Frame* targetFrame = isFormSubmission ? nullptr : findFrameForNavigation(frameName);
1317     if (targetFrame && targetFrame != &m_frame) {
1318         frameLoadRequest.setFrameName("_self");
1319         targetFrame->loader().loadURL(WTFMove(frameLoadRequest), referrer, newLoadType, event, formState, completionHandlerCaller.release());
1320         return;
1321     }
1322
1323     if (!isNavigationAllowed())
1324         return;
1325
1326     NavigationAction action { frameLoadRequest.requester(), request, frameLoadRequest.initiatedByMainFrame(), newLoadType, isFormSubmission, event, frameLoadRequest.shouldOpenExternalURLsPolicy(), frameLoadRequest.downloadAttribute() };
1327     action.setIsCrossOriginWindowOpenNavigation(frameLoadRequest.isCrossOriginWindowOpenNavigation());
1328     if (auto* opener = this->opener()) {
1329         auto pageID = opener->loader().client().pageID();
1330         auto frameID = opener->loader().client().frameID();
1331         if (pageID && frameID)
1332             action.setOpener(std::make_pair(*pageID, *frameID));
1333     }
1334
1335     if (!targetFrame && !frameName.isEmpty()) {
1336         action = action.copyWithShouldOpenExternalURLsPolicy(shouldOpenExternalURLsPolicyToApply(m_frame, frameLoadRequest));
1337         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) {
1338             continueLoadAfterNewWindowPolicy(request, formState, frameName, action, shouldContinue, allowNavigationToInvalidURL, openerPolicy);
1339             completionHandler();
1340         });
1341         return;
1342     }
1343
1344     RefPtr<DocumentLoader> oldDocumentLoader = m_documentLoader;
1345
1346     bool sameURL = shouldTreatURLAsSameAsCurrent(newURL);
1347     const String& httpMethod = request.httpMethod();
1348     
1349     // Make sure to do scroll to fragment processing even if the URL is
1350     // exactly the same so pages with '#' links and DHTML side effects
1351     // work properly.
1352     if (shouldPerformFragmentNavigation(isFormSubmission, httpMethod, newLoadType, newURL)) {
1353         oldDocumentLoader->setTriggeringAction(action);
1354         oldDocumentLoader->setLastCheckedRequest(ResourceRequest());
1355         policyChecker().stopCheck();
1356         policyChecker().setLoadType(newLoadType);
1357         policyChecker().checkNavigationPolicy(ResourceRequest(request), false /* didReceiveRedirectResponse */, oldDocumentLoader.get(), formState, [this, protectedFrame = makeRef(m_frame)] (const ResourceRequest& request, FormState*, ShouldContinue shouldContinue) {
1358             continueFragmentScrollAfterNavigationPolicy(request, shouldContinue == ShouldContinue::Yes);
1359         }, PolicyDecisionMode::Synchronous);
1360         return;
1361     }
1362
1363     // Must grab this now, since this load may stop the previous load and clear this flag.
1364     bool isRedirect = m_quickRedirectComing;
1365     request.setSystemPreview(frameLoadRequest.isSystemPreview());
1366     loadWithNavigationAction(request, action, lockHistory, newLoadType, formState, allowNavigationToInvalidURL, [this, isRedirect, sameURL, newLoadType, protectedFrame = makeRef(m_frame), completionHandler = completionHandlerCaller.release()] {
1367         if (isRedirect) {
1368             m_quickRedirectComing = false;
1369             if (m_provisionalDocumentLoader)
1370                 m_provisionalDocumentLoader->setIsClientRedirect(true);
1371             else if (m_policyDocumentLoader)
1372                 m_policyDocumentLoader->setIsClientRedirect(true);
1373         } else if (sameURL && !isReload(newLoadType)) {
1374             // Example of this case are sites that reload the same URL with a different cookie
1375             // driving the generated content, or a master frame with links that drive a target
1376             // frame, where the user has clicked on the same link repeatedly.
1377             m_loadType = FrameLoadType::Same;
1378         }
1379         completionHandler();
1380     });
1381 }
1382
1383 SubstituteData FrameLoader::defaultSubstituteDataForURL(const URL& url)
1384 {
1385     if (!shouldTreatURLAsSrcdocDocument(url))
1386         return SubstituteData();
1387     auto& srcdoc = m_frame.ownerElement()->attributeWithoutSynchronization(srcdocAttr);
1388     ASSERT(!srcdoc.isNull());
1389     CString encodedSrcdoc = srcdoc.string().utf8();
1390
1391     ResourceResponse response(URL(), ASCIILiteral("text/html"), encodedSrcdoc.length(), ASCIILiteral("UTF-8"));
1392     return SubstituteData(SharedBuffer::create(encodedSrcdoc.data(), encodedSrcdoc.length()), URL(), response, SubstituteData::SessionHistoryVisibility::Hidden);
1393 }
1394
1395 void FrameLoader::load(FrameLoadRequest&& request)
1396 {
1397     if (m_inStopAllLoaders)
1398         return;
1399
1400     if (!request.frameName().isEmpty()) {
1401         Frame* frame = findFrameForNavigation(request.frameName());
1402         if (frame) {
1403             request.setShouldCheckNewWindowPolicy(false);
1404             if (&frame->loader() != this) {
1405                 frame->loader().load(WTFMove(request));
1406                 return;
1407             }
1408         }
1409     }
1410
1411     if (request.shouldCheckNewWindowPolicy()) {
1412         NavigationAction action { request.requester(), request.resourceRequest(), InitiatedByMainFrame::Unknown, NavigationType::Other, request.shouldOpenExternalURLsPolicy() };
1413         policyChecker().checkNewWindowPolicy(WTFMove(action), request.resourceRequest(), nullptr, request.frameName(), [this] (const ResourceRequest& request, FormState* formState, const String& frameName, const NavigationAction& action, ShouldContinue shouldContinue) {
1414             continueLoadAfterNewWindowPolicy(request, formState, frameName, action, shouldContinue, AllowNavigationToInvalidURL::Yes, NewFrameOpenerPolicy::Suppress);
1415         });
1416
1417         return;
1418     }
1419
1420     if (!request.hasSubstituteData())
1421         request.setSubstituteData(defaultSubstituteDataForURL(request.resourceRequest().url()));
1422
1423     Ref<DocumentLoader> loader = m_client.createDocumentLoader(request.resourceRequest(), request.substituteData());
1424     addSameSiteInfoToRequestIfNeeded(loader->request());
1425     applyShouldOpenExternalURLsPolicyToNewDocumentLoader(m_frame, loader, request);
1426
1427     SetForScope<bool> currentLoadShouldCheckNavigationPolicyGuard(m_currentLoadShouldCheckNavigationPolicy, request.shouldCheckNavigationPolicy());
1428     load(loader.ptr());
1429 }
1430
1431 void FrameLoader::loadWithNavigationAction(const ResourceRequest& request, const NavigationAction& action, LockHistory lockHistory, FrameLoadType type, FormState* formState, AllowNavigationToInvalidURL allowNavigationToInvalidURL, CompletionHandler<void()>&& completionHandler)
1432 {
1433     Ref<DocumentLoader> loader = m_client.createDocumentLoader(request, defaultSubstituteDataForURL(request.url()));
1434     applyShouldOpenExternalURLsPolicyToNewDocumentLoader(m_frame, loader, action.initiatedByMainFrame(), action.shouldOpenExternalURLsPolicy());
1435
1436     if (lockHistory == LockHistory::Yes && m_documentLoader)
1437         loader->setClientRedirectSourceForHistory(m_documentLoader->didCreateGlobalHistoryEntry() ? m_documentLoader->urlForHistory().string() : m_documentLoader->clientRedirectSourceForHistory());
1438
1439     loader->setTriggeringAction(action);
1440     if (m_documentLoader)
1441         loader->setOverrideEncoding(m_documentLoader->overrideEncoding());
1442
1443     loadWithDocumentLoader(loader.ptr(), type, formState, allowNavigationToInvalidURL, NavigationPolicyCheck::Require, WTFMove(completionHandler));
1444 }
1445
1446 void FrameLoader::load(DocumentLoader* newDocumentLoader)
1447 {
1448     ResourceRequest& r = newDocumentLoader->request();
1449     addExtraFieldsToMainResourceRequest(r);
1450     FrameLoadType type;
1451
1452     if (shouldTreatURLAsSameAsCurrent(newDocumentLoader->originalRequest().url())) {
1453         r.setCachePolicy(ReloadIgnoringCacheData);
1454         type = FrameLoadType::Same;
1455     } else if (shouldTreatURLAsSameAsCurrent(newDocumentLoader->unreachableURL()) && isReload(m_loadType))
1456         type = m_loadType;
1457     else if (m_loadType == FrameLoadType::RedirectWithLockedBackForwardList && !newDocumentLoader->unreachableURL().isEmpty() && newDocumentLoader->substituteData().isValid())
1458         type = FrameLoadType::RedirectWithLockedBackForwardList;
1459     else
1460         type = FrameLoadType::Standard;
1461
1462     if (m_documentLoader)
1463         newDocumentLoader->setOverrideEncoding(m_documentLoader->overrideEncoding());
1464     
1465     // When we loading alternate content for an unreachable URL that we're
1466     // visiting in the history list, we treat it as a reload so the history list 
1467     // is appropriately maintained.
1468     //
1469     // FIXME: This seems like a dangerous overloading of the meaning of "FrameLoadType::Reload" ...
1470     // shouldn't a more explicit type of reload be defined, that means roughly 
1471     // "load without affecting history" ? 
1472     if (shouldReloadToHandleUnreachableURL(newDocumentLoader)) {
1473         // shouldReloadToHandleUnreachableURL() returns true only when the original load type is back-forward.
1474         // In this case we should save the document state now. Otherwise the state can be lost because load type is
1475         // changed and updateForBackForwardNavigation() will not be called when loading is committed.
1476         history().saveDocumentAndScrollState();
1477
1478         ASSERT(type == FrameLoadType::Standard);
1479         type = FrameLoadType::Reload;
1480     }
1481
1482     loadWithDocumentLoader(newDocumentLoader, type, 0, AllowNavigationToInvalidURL::Yes, NavigationPolicyCheck::Require, [] { });
1483 }
1484
1485 void FrameLoader::loadWithDocumentLoader(DocumentLoader* loader, FrameLoadType type, FormState* formState, AllowNavigationToInvalidURL allowNavigationToInvalidURL, NavigationPolicyCheck, CompletionHandler<void()>&& completionHandler)
1486 {
1487     // Retain because dispatchBeforeLoadEvent may release the last reference to it.
1488     Ref<Frame> protect(m_frame);
1489
1490     CompletionHandlerCallingScope completionHandlerCaller(WTFMove(completionHandler));
1491
1492     ASSERT(m_client.hasWebView());
1493
1494     // Unfortunately the view must be non-nil, this is ultimately due
1495     // to parser requiring a FrameView.  We should fix this dependency.
1496
1497     ASSERT(m_frame.view());
1498
1499     if (!isNavigationAllowed())
1500         return;
1501
1502     if (m_frame.document())
1503         m_previousURL = m_frame.document()->url();
1504
1505     const URL& newURL = loader->request().url();
1506
1507     // Log main frame navigation types.
1508     if (m_frame.isMainFrame()) {
1509         if (auto* page = m_frame.page()) {
1510             page->mainFrameLoadStarted(newURL, type);
1511             page->performanceLogging().didReachPointOfInterest(PerformanceLogging::MainFrameLoadStarted);
1512         }
1513     }
1514
1515     policyChecker().setLoadType(type);
1516     bool isFormSubmission = formState;
1517
1518     const String& httpMethod = loader->request().httpMethod();
1519
1520     if (shouldPerformFragmentNavigation(isFormSubmission, httpMethod, policyChecker().loadType(), newURL)) {
1521         RefPtr<DocumentLoader> oldDocumentLoader = m_documentLoader;
1522         NavigationAction action { *m_frame.document(), loader->request(), InitiatedByMainFrame::Unknown, policyChecker().loadType(), isFormSubmission };
1523
1524         oldDocumentLoader->setTriggeringAction(action);
1525         oldDocumentLoader->setLastCheckedRequest(ResourceRequest());
1526         policyChecker().stopCheck();
1527         policyChecker().checkNavigationPolicy(ResourceRequest(loader->request()), false /* didReceiveRedirectResponse */, oldDocumentLoader.get(), formState, [this, protectedFrame = makeRef(m_frame)] (const ResourceRequest& request, FormState*, ShouldContinue shouldContinue) {
1528             continueFragmentScrollAfterNavigationPolicy(request, shouldContinue == ShouldContinue::Yes);
1529         }, PolicyDecisionMode::Synchronous);
1530         return;
1531     }
1532
1533     if (Frame* parent = m_frame.tree().parent())
1534         loader->setOverrideEncoding(parent->loader().documentLoader()->overrideEncoding());
1535
1536     policyChecker().stopCheck();
1537     setPolicyDocumentLoader(loader);
1538     if (loader->triggeringAction().isEmpty())
1539         loader->setTriggeringAction({ *m_frame.document(), loader->request(), InitiatedByMainFrame::Unknown, policyChecker().loadType(), isFormSubmission });
1540
1541     if (Element* ownerElement = m_frame.ownerElement()) {
1542         // We skip dispatching the beforeload event if we've already
1543         // committed a real document load because the event would leak
1544         // subsequent activity by the frame which the parent frame isn't
1545         // supposed to learn. For example, if the child frame navigated to
1546         // a new URL, the parent frame shouldn't learn the URL.
1547         if (!m_stateMachine.committedFirstRealDocumentLoad()
1548             && !ownerElement->dispatchBeforeLoadEvent(loader->request().url().string())) {
1549             continueLoadAfterNavigationPolicy(loader->request(), formState, ShouldContinue::No, allowNavigationToInvalidURL);
1550             return;
1551         }
1552     }
1553
1554     m_frame.navigationScheduler().cancel(true);
1555
1556     if (!m_currentLoadShouldCheckNavigationPolicy) {
1557         continueLoadAfterNavigationPolicy(loader->request(), formState, ShouldContinue::Yes, allowNavigationToInvalidURL);
1558         return;
1559     }
1560
1561     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) {
1562         continueLoadAfterNavigationPolicy(request, formState, shouldContinue, allowNavigationToInvalidURL);
1563         completionHandler();
1564     });
1565 }
1566
1567 void FrameLoader::clearProvisionalLoadForPolicyCheck()
1568 {
1569     if (!m_policyDocumentLoader || !m_provisionalDocumentLoader)
1570         return;
1571
1572     m_provisionalDocumentLoader->stopLoading();
1573     setProvisionalDocumentLoader(nullptr);
1574 }
1575
1576 void FrameLoader::reportLocalLoadFailed(Frame* frame, const String& url)
1577 {
1578     ASSERT(!url.isEmpty());
1579     if (!frame)
1580         return;
1581
1582     frame->document()->addConsoleMessage(MessageSource::Security, MessageLevel::Error, "Not allowed to load local resource: " + url);
1583 }
1584
1585 void FrameLoader::reportBlockedPortFailed(Frame* frame, const String& url)
1586 {
1587     ASSERT(!url.isEmpty());
1588     if (!frame)
1589         return;
1590     
1591     frame->document()->addConsoleMessage(MessageSource::Security, MessageLevel::Error, "Not allowed to use restricted network port: " + url);
1592 }
1593
1594 void FrameLoader::reportAuthenticationChallengeBlocked(Frame* frame, const URL& url, const String& reason)
1595 {
1596     if (!frame)
1597         return;
1598
1599     frame->document()->addConsoleMessage(MessageSource::Security, MessageLevel::Error, makeString("Blocked ", url.stringCenterEllipsizedToLength(), " from asking for credentials because ", reason, '.'));
1600 }
1601
1602 const ResourceRequest& FrameLoader::initialRequest() const
1603 {
1604     return activeDocumentLoader()->originalRequest();
1605 }
1606
1607 bool FrameLoader::willLoadMediaElementURL(URL& url)
1608 {
1609 #if PLATFORM(IOS)
1610     // MobileStore depends on the iOS 4.0 era client delegate method because webView:resource:willSendRequest:redirectResponse:fromDataSource
1611     // doesn't let them tell when a load request is coming from a media element. See <rdar://problem/8266916> for more details.
1612     if (IOSApplication::isMobileStore())
1613         return m_client.shouldLoadMediaElementURL(url);
1614 #endif
1615
1616     ResourceRequest request(url);
1617
1618     unsigned long identifier;
1619     ResourceError error;
1620     requestFromDelegate(request, identifier, error);
1621     notifier().sendRemainingDelegateMessages(m_documentLoader.get(), identifier, request, ResourceResponse(url, String(), -1, String()), 0, -1, -1, error);
1622
1623     url = request.url();
1624
1625     return error.isNull();
1626 }
1627
1628 bool FrameLoader::shouldReloadToHandleUnreachableURL(DocumentLoader* docLoader)
1629 {
1630     URL unreachableURL = docLoader->unreachableURL();
1631
1632     if (unreachableURL.isEmpty())
1633         return false;
1634
1635     if (!isBackForwardLoadType(policyChecker().loadType()))
1636         return false;
1637
1638     // We only treat unreachableURLs specially during the delegate callbacks
1639     // for provisional load errors and navigation policy decisions. The former
1640     // case handles well-formed URLs that can't be loaded, and the latter
1641     // case handles malformed URLs and unknown schemes. Loading alternate content
1642     // at other times behaves like a standard load.
1643     if (policyChecker().delegateIsDecidingNavigationPolicy() || policyChecker().delegateIsHandlingUnimplementablePolicy())
1644         return m_policyDocumentLoader && unreachableURL == m_policyDocumentLoader->request().url();
1645
1646     return unreachableURL == m_provisionalLoadErrorBeingHandledURL;
1647 }
1648
1649 void FrameLoader::reloadWithOverrideEncoding(const String& encoding)
1650 {
1651     if (!m_documentLoader)
1652         return;
1653
1654     ResourceRequest request = m_documentLoader->request();
1655     URL unreachableURL = m_documentLoader->unreachableURL();
1656     if (!unreachableURL.isEmpty())
1657         request.setURL(unreachableURL);
1658
1659     // FIXME: If the resource is a result of form submission and is not cached, the form will be silently resubmitted.
1660     // We should ask the user for confirmation in this case.
1661     request.setCachePolicy(ReturnCacheDataElseLoad);
1662
1663     Ref<DocumentLoader> loader = m_client.createDocumentLoader(request, defaultSubstituteDataForURL(request.url()));
1664     applyShouldOpenExternalURLsPolicyToNewDocumentLoader(m_frame, loader, InitiatedByMainFrame::Unknown, m_documentLoader->shouldOpenExternalURLsPolicyToPropagate());
1665
1666     setPolicyDocumentLoader(loader.ptr());
1667
1668     loader->setOverrideEncoding(encoding);
1669
1670     loadWithDocumentLoader(loader.ptr(), FrameLoadType::Reload, 0, AllowNavigationToInvalidURL::Yes, NavigationPolicyCheck::Require, [] { });
1671 }
1672
1673 void FrameLoader::reload(OptionSet<ReloadOption> options)
1674 {
1675     if (!m_documentLoader)
1676         return;
1677
1678     // If a window is created by javascript, its main frame can have an empty but non-nil URL.
1679     // Reloading in this case will lose the current contents (see 4151001).
1680     if (m_documentLoader->request().url().isEmpty())
1681         return;
1682
1683     // Replace error-page URL with the URL we were trying to reach.
1684     ResourceRequest initialRequest = m_documentLoader->request();
1685     URL unreachableURL = m_documentLoader->unreachableURL();
1686     if (!unreachableURL.isEmpty())
1687         initialRequest.setURL(unreachableURL);
1688
1689     // Create a new document loader for the reload, this will become m_documentLoader eventually,
1690     // but first it has to be the "policy" document loader, and then the "provisional" document loader.
1691     Ref<DocumentLoader> loader = m_client.createDocumentLoader(initialRequest, defaultSubstituteDataForURL(initialRequest.url()));
1692     applyShouldOpenExternalURLsPolicyToNewDocumentLoader(m_frame, loader, InitiatedByMainFrame::Unknown, m_documentLoader->shouldOpenExternalURLsPolicyToPropagate());
1693
1694     loader->setUserContentExtensionsEnabled(!options.contains(ReloadOption::DisableContentBlockers));
1695     
1696     ResourceRequest& request = loader->request();
1697
1698     // FIXME: We don't have a mechanism to revalidate the main resource without reloading at the moment.
1699     request.setCachePolicy(ReloadIgnoringCacheData);
1700
1701     addSameSiteInfoToRequestIfNeeded(request);
1702
1703     // If we're about to re-post, set up action so the application can warn the user.
1704     if (request.httpMethod() == "POST")
1705         loader->setTriggeringAction({ *m_frame.document(), request, InitiatedByMainFrame::Unknown, NavigationType::FormResubmitted });
1706
1707     loader->setOverrideEncoding(m_documentLoader->overrideEncoding());
1708
1709     auto frameLoadTypeForReloadOptions = [] (auto options) {
1710         if (options & ReloadOption::FromOrigin)
1711             return FrameLoadType::ReloadFromOrigin;
1712         if (options & ReloadOption::ExpiredOnly)
1713             return FrameLoadType::ReloadExpiredOnly;
1714         return FrameLoadType::Reload;
1715     };
1716     
1717     loadWithDocumentLoader(loader.ptr(), frameLoadTypeForReloadOptions(options), 0, AllowNavigationToInvalidURL::Yes, NavigationPolicyCheck::Require, [] { });
1718 }
1719
1720 void FrameLoader::stopAllLoaders(ClearProvisionalItemPolicy clearProvisionalItemPolicy)
1721 {
1722     ASSERT(!m_frame.document() || m_frame.document()->pageCacheState() != Document::InPageCache);
1723     if (!isStopLoadingAllowed())
1724         return;
1725
1726     // If this method is called from within this method, infinite recursion can occur (3442218). Avoid this.
1727     if (m_inStopAllLoaders)
1728         return;
1729
1730     // This method might dispatch events.
1731     RELEASE_ASSERT_WITH_SECURITY_IMPLICATION(ScriptDisallowedScope::InMainThread::isScriptAllowed());
1732
1733     // Calling stopLoading() on the provisional document loader can blow away
1734     // the frame from underneath.
1735     Ref<Frame> protect(m_frame);
1736
1737     m_inStopAllLoaders = true;
1738
1739     policyChecker().stopCheck();
1740
1741     // If no new load is in progress, we should clear the provisional item from history
1742     // before we call stopLoading.
1743     if (clearProvisionalItemPolicy == ShouldClearProvisionalItem)
1744         history().setProvisionalItem(nullptr);
1745
1746     for (RefPtr<Frame> child = m_frame.tree().firstChild(); child; child = child->tree().nextSibling())
1747         child->loader().stopAllLoaders(clearProvisionalItemPolicy);
1748     if (m_provisionalDocumentLoader)
1749         m_provisionalDocumentLoader->stopLoading();
1750     if (m_documentLoader)
1751         m_documentLoader->stopLoading();
1752
1753     setProvisionalDocumentLoader(nullptr);
1754
1755     m_checkTimer.stop();
1756
1757     m_inStopAllLoaders = false;    
1758 }
1759
1760 void FrameLoader::stopForUserCancel(bool deferCheckLoadComplete)
1761 {
1762     // Calling stopAllLoaders can cause the frame to be deallocated, including the frame loader.
1763     Ref<Frame> protectedFrame(m_frame);
1764
1765     stopAllLoaders();
1766
1767 #if PLATFORM(IOS)
1768     // Lay out immediately when stopping to immediately clear the old page if we just committed this one
1769     // but haven't laid out/painted yet.
1770     // FIXME: Is this behavior specific to iOS? Or should we expose a setting to toggle this behavior?
1771     if (m_frame.view() && !m_frame.view()->didFirstLayout())
1772         m_frame.view()->layoutContext().layout();
1773 #endif
1774
1775     if (deferCheckLoadComplete)
1776         scheduleCheckLoadComplete();
1777     else if (m_frame.page())
1778         checkLoadComplete();
1779 }
1780
1781 DocumentLoader* FrameLoader::activeDocumentLoader() const
1782 {
1783     if (m_state == FrameStateProvisional)
1784         return m_provisionalDocumentLoader.get();
1785     return m_documentLoader.get();
1786 }
1787
1788 bool FrameLoader::isLoading() const
1789 {
1790     DocumentLoader* docLoader = activeDocumentLoader();
1791     if (!docLoader)
1792         return false;
1793     return docLoader->isLoading();
1794 }
1795
1796 bool FrameLoader::frameHasLoaded() const
1797 {
1798     return m_stateMachine.committedFirstRealDocumentLoad() || (m_provisionalDocumentLoader && !m_stateMachine.creatingInitialEmptyDocument()); 
1799 }
1800
1801 void FrameLoader::setDocumentLoader(DocumentLoader* loader)
1802 {
1803     if (!loader && !m_documentLoader)
1804         return;
1805     
1806     ASSERT(loader != m_documentLoader);
1807     ASSERT(!loader || loader->frameLoader() == this);
1808
1809     m_client.prepareForDataSourceReplacement();
1810     detachChildren();
1811
1812     // detachChildren() can trigger this frame's unload event, and therefore
1813     // script can run and do just about anything. For example, an unload event that calls
1814     // document.write("") on its parent frame can lead to a recursive detachChildren()
1815     // invocation for this frame. In that case, we can end up at this point with a
1816     // loader that hasn't been deleted but has been detached from its frame. Such a
1817     // DocumentLoader has been sufficiently detached that we'll end up in an inconsistent
1818     // state if we try to use it.
1819     if (loader && !loader->frame())
1820         return;
1821
1822     if (m_documentLoader)
1823         m_documentLoader->detachFromFrame();
1824
1825     m_documentLoader = loader;
1826 }
1827
1828 void FrameLoader::setPolicyDocumentLoader(DocumentLoader* loader)
1829 {
1830     if (m_policyDocumentLoader == loader)
1831         return;
1832
1833     if (loader)
1834         loader->attachToFrame(m_frame);
1835     if (m_policyDocumentLoader
1836             && m_policyDocumentLoader != m_provisionalDocumentLoader
1837             && m_policyDocumentLoader != m_documentLoader)
1838         m_policyDocumentLoader->detachFromFrame();
1839
1840     m_policyDocumentLoader = loader;
1841 }
1842
1843 void FrameLoader::setProvisionalDocumentLoader(DocumentLoader* loader)
1844 {
1845     ASSERT(!loader || !m_provisionalDocumentLoader);
1846     ASSERT(!loader || loader->frameLoader() == this);
1847
1848     if (m_provisionalDocumentLoader && m_provisionalDocumentLoader != m_documentLoader)
1849         m_provisionalDocumentLoader->detachFromFrame();
1850
1851     m_provisionalDocumentLoader = loader;
1852 }
1853
1854 void FrameLoader::setState(FrameState newState)
1855 {
1856     FrameState oldState = m_state;
1857     m_state = newState;
1858     
1859     if (newState == FrameStateProvisional)
1860         provisionalLoadStarted();
1861     else if (newState == FrameStateComplete) {
1862         frameLoadCompleted();
1863         if (m_documentLoader)
1864             m_documentLoader->stopRecordingResponses();
1865         if (m_frame.isMainFrame() && oldState != newState)
1866             m_frame.page()->performanceLogging().didReachPointOfInterest(PerformanceLogging::MainFrameLoadCompleted);
1867     }
1868 }
1869
1870 void FrameLoader::clearProvisionalLoad()
1871 {
1872     setProvisionalDocumentLoader(nullptr);
1873     m_progressTracker->progressCompleted();
1874     setState(FrameStateComplete);
1875 }
1876
1877 void FrameLoader::commitProvisionalLoad()
1878 {
1879     RefPtr<DocumentLoader> pdl = m_provisionalDocumentLoader;
1880     Ref<Frame> protect(m_frame);
1881
1882     std::unique_ptr<CachedPage> cachedPage;
1883     if (m_loadingFromCachedPage && history().provisionalItem())
1884         cachedPage = PageCache::singleton().take(*history().provisionalItem(), m_frame.page());
1885
1886     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(),
1887         m_frame.document() ? m_frame.document()->url().stringCenterEllipsizedToLength().utf8().data() : "",
1888         pdl ? pdl->url().stringCenterEllipsizedToLength().utf8().data() : "<no provisional DocumentLoader>", cachedPage.get());
1889
1890     willTransitionToCommitted();
1891
1892     if (!m_frame.tree().parent() && history().currentItem()) {
1893         // Check to see if we need to cache the page we are navigating away from into the back/forward cache.
1894         // We are doing this here because we know for sure that a new page is about to be loaded.
1895         PageCache::singleton().addIfCacheable(*history().currentItem(), m_frame.page());
1896         
1897         WebCore::jettisonExpensiveObjectsOnTopLevelNavigation();
1898     }
1899
1900     if (m_loadType != FrameLoadType::Replace)
1901         closeOldDataSources();
1902
1903     if (!cachedPage && !m_stateMachine.creatingInitialEmptyDocument())
1904         m_client.makeRepresentation(pdl.get());
1905
1906     transitionToCommitted(cachedPage.get());
1907
1908     if (pdl && m_documentLoader) {
1909         // Check if the destination page is allowed to access the previous page's timing information.
1910         Ref<SecurityOrigin> securityOrigin(SecurityOrigin::create(pdl->request().url()));
1911         m_documentLoader->timing().setHasSameOriginAsPreviousDocument(securityOrigin.get().canRequest(m_previousURL));
1912     }
1913
1914     // Call clientRedirectCancelledOrFinished() here so that the frame load delegate is notified that the redirect's
1915     // status has changed, if there was a redirect.  The frame load delegate may have saved some state about
1916     // the redirect in its -webView:willPerformClientRedirectToURL:delay:fireDate:forFrame:.  Since we are
1917     // just about to commit a new page, there cannot possibly be a pending redirect at this point.
1918     if (m_sentRedirectNotification)
1919         clientRedirectCancelledOrFinished(false);
1920     
1921     if (cachedPage && cachedPage->document()) {
1922 #if PLATFORM(IOS)
1923         // FIXME: CachedPage::restore() would dispatch viewport change notification. However UIKit expects load
1924         // commit to happen before any changes to viewport arguments and dealing with this there is difficult.
1925         m_frame.page()->chrome().setDispatchViewportDataDidChangeSuppressed(true);
1926 #endif
1927         willRestoreFromCachedPage();
1928
1929         // Start request for the main resource and dispatch didReceiveResponse before the load is committed for
1930         // consistency with all other loads. See https://bugs.webkit.org/show_bug.cgi?id=150927.
1931         ResourceError mainResouceError;
1932         unsigned long mainResourceIdentifier;
1933         ResourceRequest mainResourceRequest(cachedPage->documentLoader()->request());
1934         requestFromDelegate(mainResourceRequest, mainResourceIdentifier, mainResouceError);
1935         notifier().dispatchDidReceiveResponse(cachedPage->documentLoader(), mainResourceIdentifier, cachedPage->documentLoader()->response());
1936
1937         std::optional<HasInsecureContent> hasInsecureContent = cachedPage->cachedMainFrame()->hasInsecureContent();
1938
1939         // FIXME: This API should be turned around so that we ground CachedPage into the Page.
1940         cachedPage->restore(*m_frame.page());
1941
1942         dispatchDidCommitLoad(hasInsecureContent);
1943
1944 #if PLATFORM(IOS)
1945         m_frame.page()->chrome().setDispatchViewportDataDidChangeSuppressed(false);
1946         m_frame.page()->chrome().dispatchViewportPropertiesDidChange(m_frame.page()->viewportArguments());
1947 #endif
1948
1949         auto& title = m_documentLoader->title();
1950         if (!title.string.isNull())
1951             m_client.dispatchDidReceiveTitle(title);
1952
1953         // Send remaining notifications for the main resource.
1954         notifier().sendRemainingDelegateMessages(m_documentLoader.get(), mainResourceIdentifier, mainResourceRequest, ResourceResponse(),
1955             nullptr, static_cast<int>(m_documentLoader->response().expectedContentLength()), 0, mainResouceError);
1956
1957         checkCompleted();
1958     } else
1959         didOpenURL();
1960
1961     LOG(Loading, "WebCoreLoading %s: Finished committing provisional load to URL %s", m_frame.tree().uniqueName().string().utf8().data(),
1962         m_frame.document() ? m_frame.document()->url().stringCenterEllipsizedToLength().utf8().data() : "");
1963
1964     if (m_loadType == FrameLoadType::Standard && m_documentLoader->isClientRedirect())
1965         history().updateForClientRedirect();
1966
1967     if (m_loadingFromCachedPage) {
1968         // Note, didReceiveDocType is expected to be called for cached pages. See <rdar://problem/5906758> for more details.
1969         if (auto* page = m_frame.page())
1970             page->chrome().didReceiveDocType(m_frame);
1971         m_frame.document()->resume(ActiveDOMObject::PageCache);
1972
1973         // Force a layout to update view size and thereby update scrollbars.
1974 #if PLATFORM(IOS)
1975         if (!m_client.forceLayoutOnRestoreFromPageCache())
1976             m_frame.view()->forceLayout();
1977 #else
1978         m_frame.view()->forceLayout();
1979 #endif
1980
1981         // Main resource delegates were already sent, so we skip the first response here.
1982         for (unsigned i = 1; i < m_documentLoader->responses().size(); ++i) {
1983             const auto& response = m_documentLoader->responses()[i];
1984             // FIXME: If the WebKit client changes or cancels the request, this is not respected.
1985             ResourceError error;
1986             unsigned long identifier;
1987             ResourceRequest request(response.url());
1988             requestFromDelegate(request, identifier, error);
1989             // FIXME: If we get a resource with more than 2B bytes, this code won't do the right thing.
1990             // However, with today's computers and networking speeds, this won't happen in practice.
1991             // Could be an issue with a giant local file.
1992             notifier().sendRemainingDelegateMessages(m_documentLoader.get(), identifier, request, response, 0, static_cast<int>(response.expectedContentLength()), 0, error);
1993         }
1994
1995         // FIXME: Why only this frame and not parent frames?
1996         checkLoadCompleteForThisFrame();
1997     }
1998 }
1999
2000 void FrameLoader::transitionToCommitted(CachedPage* cachedPage)
2001 {
2002     ASSERT(m_client.hasWebView());
2003     ASSERT(m_state == FrameStateProvisional);
2004
2005     if (m_state != FrameStateProvisional)
2006         return;
2007
2008     if (FrameView* view = m_frame.view()) {
2009         if (ScrollAnimator* scrollAnimator = view->existingScrollAnimator())
2010             scrollAnimator->cancelAnimations();
2011     }
2012
2013     m_client.setCopiesOnScroll();
2014     history().updateForCommit();
2015
2016     // The call to closeURL() invokes the unload event handler, which can execute arbitrary
2017     // JavaScript. If the script initiates a new load, we need to abandon the current load,
2018     // or the two will stomp each other.
2019     DocumentLoader* pdl = m_provisionalDocumentLoader.get();
2020     if (m_documentLoader)
2021         closeURL();
2022     if (pdl != m_provisionalDocumentLoader)
2023         return;
2024
2025     if (m_documentLoader)
2026         m_documentLoader->stopLoadingSubresources();
2027     if (m_documentLoader)
2028         m_documentLoader->stopLoadingPlugIns();
2029
2030     // Setting our document loader invokes the unload event handler of our child frames.
2031     // Script can do anything. If the script initiates a new load, we need to abandon the
2032     // current load or the two will stomp each other.
2033     setDocumentLoader(m_provisionalDocumentLoader.get());
2034     if (pdl != m_provisionalDocumentLoader)
2035         return;
2036     setProvisionalDocumentLoader(nullptr);
2037
2038     // Nothing else can interrupt this commit - set the Provisional->Committed transition in stone
2039     setState(FrameStateCommittedPage);
2040
2041     // Handle adding the URL to the back/forward list.
2042     DocumentLoader* dl = m_documentLoader.get();
2043
2044     switch (m_loadType) {
2045     case FrameLoadType::Forward:
2046     case FrameLoadType::Back:
2047     case FrameLoadType::IndexedBackForward:
2048         if (m_frame.page()) {
2049             // If the first load within a frame is a navigation within a back/forward list that was attached
2050             // without any of the items being loaded then we need to update the history in a similar manner as
2051             // for a standard load with the exception of updating the back/forward list (<rdar://problem/8091103>).
2052             if (!m_stateMachine.committedFirstRealDocumentLoad() && m_frame.isMainFrame())
2053                 history().updateForStandardLoad(HistoryController::UpdateAllExceptBackForwardList);
2054
2055             history().updateForBackForwardNavigation();
2056
2057             // For cached pages, CachedFrame::restore will take care of firing the popstate event with the history item's state object
2058             if (history().currentItem() && !cachedPage)
2059                 m_pendingStateObject = history().currentItem()->stateObject();
2060
2061             // Create a document view for this document, or used the cached view.
2062             if (cachedPage) {
2063                 DocumentLoader* cachedDocumentLoader = cachedPage->documentLoader();
2064                 ASSERT(cachedDocumentLoader);
2065                 cachedDocumentLoader->attachToFrame(m_frame);
2066                 m_client.transitionToCommittedFromCachedFrame(cachedPage->cachedMainFrame());
2067             } else
2068                 m_client.transitionToCommittedForNewPage();
2069         }
2070         break;
2071
2072     case FrameLoadType::Reload:
2073     case FrameLoadType::ReloadFromOrigin:
2074     case FrameLoadType::ReloadExpiredOnly:
2075     case FrameLoadType::Same:
2076     case FrameLoadType::Replace:
2077         history().updateForReload();
2078         m_client.transitionToCommittedForNewPage();
2079         break;
2080
2081     case FrameLoadType::Standard:
2082         history().updateForStandardLoad();
2083         if (m_frame.view())
2084             m_frame.view()->setScrollbarsSuppressed(true);
2085         m_client.transitionToCommittedForNewPage();
2086         break;
2087
2088     case FrameLoadType::RedirectWithLockedBackForwardList:
2089         history().updateForRedirectWithLockedBackForwardList();
2090         m_client.transitionToCommittedForNewPage();
2091         break;
2092     }
2093
2094     m_documentLoader->writer().setMIMEType(dl->responseMIMEType());
2095
2096     // Tell the client we've committed this URL.
2097     ASSERT(m_frame.view());
2098
2099     if (m_stateMachine.creatingInitialEmptyDocument())
2100         return;
2101
2102     if (!m_stateMachine.committedFirstRealDocumentLoad())
2103         m_stateMachine.advanceTo(FrameLoaderStateMachine::DisplayingInitialEmptyDocumentPostCommit);
2104 }
2105
2106 void FrameLoader::clientRedirectCancelledOrFinished(bool cancelWithLoadInProgress)
2107 {
2108     // Note that -webView:didCancelClientRedirectForFrame: is called on the frame load delegate even if
2109     // the redirect succeeded.  We should either rename this API, or add a new method, like
2110     // -webView:didFinishClientRedirectForFrame:
2111     m_client.dispatchDidCancelClientRedirect();
2112
2113     if (!cancelWithLoadInProgress)
2114         m_quickRedirectComing = false;
2115
2116     m_sentRedirectNotification = false;
2117 }
2118
2119 void FrameLoader::clientRedirected(const URL& url, double seconds, WallTime fireDate, LockBackForwardList lockBackForwardList)
2120 {
2121     m_client.dispatchWillPerformClientRedirect(url, seconds, fireDate);
2122     
2123     // Remember that we sent a redirect notification to the frame load delegate so that when we commit
2124     // the next provisional load, we can send a corresponding -webView:didCancelClientRedirectForFrame:
2125     m_sentRedirectNotification = true;
2126     
2127     // If a "quick" redirect comes in, we set a special mode so we treat the next
2128     // load as part of the original navigation. If we don't have a document loader, we have
2129     // no "original" load on which to base a redirect, so we treat the redirect as a normal load.
2130     // Loads triggered by JavaScript form submissions never count as quick redirects.
2131     m_quickRedirectComing = (lockBackForwardList == LockBackForwardList::Yes || history().currentItemShouldBeReplaced()) && m_documentLoader && !m_isExecutingJavaScriptFormAction;
2132 }
2133
2134 bool FrameLoader::shouldReload(const URL& currentURL, const URL& destinationURL)
2135 {
2136     // This function implements the rule: "Don't reload if navigating by fragment within
2137     // the same URL, but do reload if going to a new URL or to the same URL with no
2138     // fragment identifier at all."
2139     if (!destinationURL.hasFragmentIdentifier())
2140         return true;
2141     return !equalIgnoringFragmentIdentifier(currentURL, destinationURL);
2142 }
2143
2144 void FrameLoader::closeOldDataSources()
2145 {
2146     // FIXME: Is it important for this traversal to be postorder instead of preorder?
2147     // If so, add helpers for postorder traversal, and use them. If not, then lets not
2148     // use a recursive algorithm here.
2149     for (Frame* child = m_frame.tree().firstChild(); child; child = child->tree().nextSibling())
2150         child->loader().closeOldDataSources();
2151     
2152     if (m_documentLoader)
2153         m_client.dispatchWillClose();
2154
2155     m_client.setMainFrameDocumentReady(false); // stop giving out the actual DOMDocument to observers
2156 }
2157
2158 void FrameLoader::willRestoreFromCachedPage()
2159 {
2160     ASSERT(!m_frame.tree().parent());
2161     ASSERT(m_frame.page());
2162     ASSERT(m_frame.isMainFrame());
2163
2164     m_frame.navigationScheduler().cancel();
2165
2166     // We still have to close the previous part page.
2167     closeURL();
2168     
2169     // Delete old status bar messages (if it _was_ activated on last URL).
2170     if (m_frame.script().canExecuteScripts(NotAboutToExecuteScript)) {
2171         DOMWindow* window = m_frame.document()->domWindow();
2172         window->setStatus(String());
2173         window->setDefaultStatus(String());
2174     }
2175 }
2176
2177 void FrameLoader::open(CachedFrameBase& cachedFrame)
2178 {
2179     m_isComplete = false;
2180     
2181     // Don't re-emit the load event.
2182     m_didCallImplicitClose = true;
2183
2184     URL url = cachedFrame.url();
2185
2186     // FIXME: I suspect this block of code doesn't do anything.
2187     if (url.protocolIsInHTTPFamily() && !url.host().isEmpty() && url.path().isEmpty())
2188         url.setPath("/");
2189
2190     started();
2191     Document* document = cachedFrame.document();
2192     ASSERT(document);
2193     ASSERT(document->domWindow());
2194
2195     clear(document, true, true, cachedFrame.isMainFrame());
2196
2197     document->setPageCacheState(Document::NotInPageCache);
2198
2199     m_needsClear = true;
2200     m_isComplete = false;
2201     m_didCallImplicitClose = false;
2202     m_outgoingReferrer = url.string();
2203
2204     FrameView* view = cachedFrame.view();
2205     
2206     // When navigating to a CachedFrame its FrameView should never be null.  If it is we'll crash in creative ways downstream.
2207     ASSERT(view);
2208     view->setWasScrolledByUser(false);
2209
2210     std::optional<IntRect> previousViewFrameRect = m_frame.view() ?  m_frame.view()->frameRect() : std::optional<IntRect>(std::nullopt);
2211     m_frame.setView(view);
2212
2213     // Use the previous ScrollView's frame rect.
2214     if (previousViewFrameRect)
2215         view->setFrameRect(previousViewFrameRect.value());
2216     
2217     m_frame.setDocument(document);
2218     document->domWindow()->resumeFromDocumentSuspension();
2219
2220     updateFirstPartyForCookies();
2221
2222     cachedFrame.restore();
2223 }
2224
2225 bool FrameLoader::isHostedByObjectElement() const
2226 {
2227     HTMLFrameOwnerElement* owner = m_frame.ownerElement();
2228     return owner && owner->hasTagName(objectTag);
2229 }
2230
2231 bool FrameLoader::isReplacing() const
2232 {
2233     return m_loadType == FrameLoadType::Replace;
2234 }
2235
2236 void FrameLoader::setReplacing()
2237 {
2238     m_loadType = FrameLoadType::Replace;
2239 }
2240
2241 bool FrameLoader::subframeIsLoading() const
2242 {
2243     // It's most likely that the last added frame is the last to load so we walk backwards.
2244     for (Frame* child = m_frame.tree().lastChild(); child; child = child->tree().previousSibling()) {
2245         FrameLoader& childLoader = child->loader();
2246         DocumentLoader* documentLoader = childLoader.documentLoader();
2247         if (documentLoader && documentLoader->isLoadingInAPISense())
2248             return true;
2249         documentLoader = childLoader.provisionalDocumentLoader();
2250         if (documentLoader && documentLoader->isLoadingInAPISense())
2251             return true;
2252         documentLoader = childLoader.policyDocumentLoader();
2253         if (documentLoader)
2254             return true;
2255     }
2256     return false;
2257 }
2258
2259 void FrameLoader::willChangeTitle(DocumentLoader* loader)
2260 {
2261     m_client.willChangeTitle(loader);
2262 }
2263
2264 FrameLoadType FrameLoader::loadType() const
2265 {
2266     return m_loadType;
2267 }
2268     
2269 CachePolicy FrameLoader::subresourceCachePolicy(const URL& url) const
2270 {
2271     if (Page* page = m_frame.page()) {
2272         if (page->isResourceCachingDisabled())
2273             return CachePolicyReload;
2274     }
2275
2276     if (m_isComplete)
2277         return CachePolicyVerify;
2278
2279     if (m_loadType == FrameLoadType::ReloadFromOrigin)
2280         return CachePolicyReload;
2281
2282     if (Frame* parentFrame = m_frame.tree().parent()) {
2283         CachePolicy parentCachePolicy = parentFrame->loader().subresourceCachePolicy(url);
2284         if (parentCachePolicy != CachePolicyVerify)
2285             return parentCachePolicy;
2286     }
2287     
2288     switch (m_loadType) {
2289     case FrameLoadType::Reload:
2290         return CachePolicyRevalidate;
2291     case FrameLoadType::Back:
2292     case FrameLoadType::Forward:
2293     case FrameLoadType::IndexedBackForward:
2294         return CachePolicyHistoryBuffer;
2295     case FrameLoadType::ReloadFromOrigin:
2296         ASSERT_NOT_REACHED(); // Already handled above.
2297         return CachePolicyReload;
2298     case FrameLoadType::RedirectWithLockedBackForwardList:
2299     case FrameLoadType::Replace:
2300     case FrameLoadType::Same:
2301     case FrameLoadType::Standard:
2302         return CachePolicyVerify;
2303     case FrameLoadType::ReloadExpiredOnly:
2304         // We know about expiration for HTTP and data. Do a normal reload otherwise.
2305         if (!url.protocolIsInHTTPFamily() && !url.protocolIsData())
2306             return CachePolicyReload;
2307         return CachePolicyVerify;
2308     }
2309
2310     RELEASE_ASSERT_NOT_REACHED();
2311     return CachePolicyVerify;
2312 }
2313
2314 void FrameLoader::checkLoadCompleteForThisFrame()
2315 {
2316     ASSERT(m_client.hasWebView());
2317
2318     // FIXME: Should this check be done in checkLoadComplete instead of here?
2319     // FIXME: Why does this one check need to be repeated here, and not the many others from checkCompleted?
2320     if (m_frame.document()->isDelayingLoadEvent())
2321         return;
2322
2323     switch (m_state) {
2324         case FrameStateProvisional: {
2325             // FIXME: Prohibiting any provisional load failures from being sent to clients
2326             // while handling provisional load failures is too heavy. For example, the current
2327             // load will fail to cancel another ongoing load. That might prevent clients' page
2328             // load state being handled properly.
2329             if (!m_provisionalLoadErrorBeingHandledURL.isEmpty())
2330                 return;
2331
2332             RefPtr<DocumentLoader> pdl = m_provisionalDocumentLoader;
2333             if (!pdl)
2334                 return;
2335                 
2336             // If we've received any errors we may be stuck in the provisional state and actually complete.
2337             const ResourceError& error = pdl->mainDocumentError();
2338             if (error.isNull())
2339                 return;
2340
2341             // Check all children first.
2342             RefPtr<HistoryItem> item;
2343             if (Page* page = m_frame.page())
2344                 if (isBackForwardLoadType(loadType()))
2345                     // Reset the back forward list to the last committed history item at the top level.
2346                     item = page->mainFrame().loader().history().currentItem();
2347                 
2348             // Only reset if we aren't already going to a new provisional item.
2349             bool shouldReset = !history().provisionalItem();
2350             if (!pdl->isLoadingInAPISense() || pdl->isStopping()) {
2351                 m_provisionalLoadErrorBeingHandledURL = m_provisionalDocumentLoader->url();
2352                 m_client.dispatchDidFailProvisionalLoad(error);
2353 #if ENABLE(CONTENT_FILTERING)
2354                 if (auto contentFilter = pdl->contentFilter())
2355                     contentFilter->handleProvisionalLoadFailure(error);
2356 #endif
2357                 m_provisionalLoadErrorBeingHandledURL = { };
2358
2359                 ASSERT(!pdl->isLoading());
2360
2361                 // If we're in the middle of loading multipart data, we need to restore the document loader.
2362                 if (isReplacing() && !m_documentLoader.get())
2363                     setDocumentLoader(m_provisionalDocumentLoader.get());
2364
2365                 // Finish resetting the load state, but only if another load hasn't been started by the
2366                 // delegate callback.
2367                 if (pdl == m_provisionalDocumentLoader)
2368                     clearProvisionalLoad();
2369                 else if (activeDocumentLoader()) {
2370                     URL unreachableURL = activeDocumentLoader()->unreachableURL();
2371                     if (!unreachableURL.isEmpty() && unreachableURL == pdl->request().url())
2372                         shouldReset = false;
2373                 }
2374             }
2375             if (shouldReset && item)
2376                 if (Page* page = m_frame.page()) {
2377                     page->backForward().setCurrentItem(item.get());
2378                     m_frame.loader().client().updateGlobalHistoryItemForPage();
2379                 }
2380             return;
2381         }
2382         
2383         case FrameStateCommittedPage: {
2384             DocumentLoader* dl = m_documentLoader.get();            
2385             if (!dl || (dl->isLoadingInAPISense() && !dl->isStopping()))
2386                 return;
2387
2388             setState(FrameStateComplete);
2389
2390             // FIXME: Is this subsequent work important if we already navigated away?
2391             // Maybe there are bugs because of that, or extra work we can skip because
2392             // the new page is ready.
2393
2394             m_client.forceLayoutForNonHTML();
2395              
2396             // If the user had a scroll point, scroll to it, overriding the anchor point if any.
2397             if (m_frame.page()) {
2398                 if (isBackForwardLoadType(m_loadType) || isReload(m_loadType))
2399                     history().restoreScrollPositionAndViewState();
2400             }
2401
2402             if (m_stateMachine.creatingInitialEmptyDocument() || !m_stateMachine.committedFirstRealDocumentLoad())
2403                 return;
2404
2405             m_progressTracker->progressCompleted();
2406             Page* page = m_frame.page();
2407             if (page) {
2408                 if (m_frame.isMainFrame()) {
2409                     tracePoint(MainResourceLoadDidEnd);
2410                     page->didFinishLoad();
2411                 }
2412             }
2413
2414             const ResourceError& error = dl->mainDocumentError();
2415
2416             AXObjectCache::AXLoadingEvent loadingEvent;
2417             if (!error.isNull()) {
2418                 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());
2419                 m_client.dispatchDidFailLoad(error);
2420                 loadingEvent = AXObjectCache::AXLoadingFailed;
2421             } else {
2422                 RELEASE_LOG_IF_ALLOWED("checkLoadCompleteForThisFrame: Finished frame load (frame = %p, main = %d)", &m_frame, m_frame.isMainFrame());
2423 #if ENABLE(DATA_DETECTION)
2424                 auto* document = m_frame.document();
2425                 if (m_frame.settings().dataDetectorTypes() != DataDetectorTypeNone && document) {
2426                     if (auto* documentElement = document->documentElement()) {
2427                         RefPtr<Range> documentRange = makeRange(firstPositionInNode(documentElement), lastPositionInNode(documentElement));
2428                         m_frame.setDataDetectionResults(DataDetection::detectContentInRange(documentRange, m_frame.settings().dataDetectorTypes(), m_client.dataDetectionContext()));
2429                         if (m_frame.isMainFrame())
2430                             m_client.dispatchDidFinishDataDetection(m_frame.dataDetectionResults());
2431                     }
2432                 }
2433 #endif
2434                 m_client.dispatchDidFinishLoad();
2435                 loadingEvent = AXObjectCache::AXLoadingFinished;
2436             }
2437
2438             // Notify accessibility.
2439             if (auto* document = m_frame.document()) {
2440                 if (AXObjectCache* cache = document->existingAXObjectCache())
2441                     cache->frameLoadingEventNotification(&m_frame, loadingEvent);
2442             }
2443
2444             // The above calls to dispatchDidFinishLoad() might have detached the Frame
2445             // from its Page and also might have caused Page to be deleted.
2446             // Don't assume 'page' is still available to use.
2447             if (m_frame.isMainFrame() && m_frame.page()) {
2448                 ASSERT(&m_frame.page()->mainFrame() == &m_frame);
2449                 m_frame.page()->diagnosticLoggingClient().logDiagnosticMessageWithResult(DiagnosticLoggingKeys::pageLoadedKey(), emptyString(), error.isNull() ? DiagnosticLoggingResultPass : DiagnosticLoggingResultFail, ShouldSample::Yes);
2450             }
2451
2452             return;
2453         }
2454         
2455         case FrameStateComplete:
2456             m_loadType = FrameLoadType::Standard;
2457             frameLoadCompleted();
2458             return;
2459     }
2460
2461     ASSERT_NOT_REACHED();
2462 }
2463
2464 void FrameLoader::setOriginalURLForDownloadRequest(ResourceRequest& request)
2465 {
2466     // FIXME: Rename firstPartyForCookies back to mainDocumentURL. It was a mistake to think that it was only used for cookies.
2467     // The originalURL is defined as the URL of the page where the download was initiated.
2468     URL originalURL;
2469     auto* initiator = m_frame.document();
2470     if (initiator) {
2471         originalURL = initiator->firstPartyForCookies();
2472         // If there is no main document URL, it means that this document is newly opened and just for download purpose.
2473         // In this case, we need to set the originalURL to this document's opener's main document URL.
2474         if (originalURL.isEmpty() && opener() && opener()->document()) {
2475             originalURL = opener()->document()->firstPartyForCookies();
2476             initiator = opener()->document();
2477         }
2478     }
2479     // If the originalURL is the same as the requested URL, we are processing a download
2480     // initiated directly without a page and do not need to specify the originalURL.
2481     if (originalURL == request.url())
2482         request.setFirstPartyForCookies(URL());
2483     else
2484         request.setFirstPartyForCookies(originalURL);
2485     addSameSiteInfoToRequestIfNeeded(request, initiator);
2486 }
2487
2488 void FrameLoader::didReachLayoutMilestone(LayoutMilestones milestones)
2489 {
2490     ASSERT(m_frame.isMainFrame());
2491
2492     m_client.dispatchDidReachLayoutMilestone(milestones);
2493 }
2494
2495 void FrameLoader::didFirstLayout()
2496 {
2497 #if PLATFORM(IOS)
2498     // Only send layout-related delegate callbacks synchronously for the main frame to
2499     // avoid reentering layout for the main frame while delivering a layout-related delegate
2500     // callback for a subframe.
2501     if (&m_frame != &m_frame.page()->mainFrame())
2502         return;
2503 #endif
2504     if (m_frame.page() && isBackForwardLoadType(m_loadType))
2505         history().restoreScrollPositionAndViewState();
2506
2507     if (m_stateMachine.committedFirstRealDocumentLoad() && !m_stateMachine.isDisplayingInitialEmptyDocument() && !m_stateMachine.firstLayoutDone())
2508         m_stateMachine.advanceTo(FrameLoaderStateMachine::FirstLayoutDone);
2509 }
2510
2511 void FrameLoader::frameLoadCompleted()
2512 {
2513     // Note: Can be called multiple times.
2514
2515     m_client.frameLoadCompleted();
2516
2517     history().updateForFrameLoadCompleted();
2518
2519     // After a canceled provisional load, firstLayoutDone is false.
2520     // Reset it to true if we're displaying a page.
2521     if (m_documentLoader && m_stateMachine.committedFirstRealDocumentLoad() && !m_stateMachine.isDisplayingInitialEmptyDocument() && !m_stateMachine.firstLayoutDone())
2522         m_stateMachine.advanceTo(FrameLoaderStateMachine::FirstLayoutDone);
2523 }
2524
2525 void FrameLoader::detachChildren()
2526 {
2527     // detachChildren() will fire the unload event in each subframe and the
2528     // HTML specification states that the parent document's ignore-opens-during-unload counter while
2529     // this event is being fired in its subframes:
2530     // https://html.spec.whatwg.org/multipage/browsers.html#unload-a-document
2531     IgnoreOpensDuringUnloadCountIncrementer ignoreOpensDuringUnloadCountIncrementer(m_frame.document());
2532
2533     // Any subframe inserted by unload event handlers executed in the loop below will not get unloaded
2534     // because we create a copy of the subframes list before looping. Therefore, it would be unsafe to
2535     // allow loading of subframes at this point.
2536     SubframeLoadingDisabler subframeLoadingDisabler(m_frame.document());
2537
2538     Vector<Ref<Frame>, 16> childrenToDetach;
2539     childrenToDetach.reserveInitialCapacity(m_frame.tree().childCount());
2540     for (Frame* child = m_frame.tree().lastChild(); child; child = child->tree().previousSibling())
2541         childrenToDetach.uncheckedAppend(*child);
2542     for (auto& child : childrenToDetach)
2543         child->loader().detachFromParent();
2544 }
2545
2546 void FrameLoader::closeAndRemoveChild(Frame& child)
2547 {
2548     child.tree().detachFromParent();
2549
2550     child.setView(nullptr);
2551     if (child.ownerElement() && child.page())
2552         child.page()->decrementSubframeCount();
2553     child.willDetachPage();
2554     child.detachFromPage();
2555
2556     m_frame.tree().removeChild(child);
2557 }
2558
2559 // Called every time a resource is completely loaded or an error is received.
2560 void FrameLoader::checkLoadComplete()
2561 {
2562     m_shouldCallCheckLoadComplete = false;
2563
2564     if (!m_frame.page())
2565         return;
2566
2567     ASSERT(m_client.hasWebView());
2568     
2569     // FIXME: Always traversing the entire frame tree is a bit inefficient, but 
2570     // is currently needed in order to null out the previous history item for all frames.
2571     Vector<Ref<Frame>, 16> frames;
2572     for (Frame* frame = &m_frame.mainFrame(); frame; frame = frame->tree().traverseNext())
2573         frames.append(*frame);
2574
2575     // To process children before their parents, iterate the vector backwards.
2576     for (auto frame = frames.rbegin(); frame != frames.rend(); ++frame) {
2577         if ((*frame)->page())
2578             (*frame)->loader().checkLoadCompleteForThisFrame();
2579     }
2580 }
2581
2582 int FrameLoader::numPendingOrLoadingRequests(bool recurse) const
2583 {
2584     if (!recurse)
2585         return m_frame.document()->cachedResourceLoader().requestCount();
2586
2587     int count = 0;
2588     for (Frame* frame = &m_frame; frame; frame = frame->tree().traverseNext(&m_frame))
2589         count += frame->document()->cachedResourceLoader().requestCount();
2590     return count;
2591 }
2592
2593 String FrameLoader::userAgent(const URL& url) const
2594 {
2595     return m_client.userAgent(url);
2596 }
2597
2598 void FrameLoader::dispatchOnloadEvents()
2599 {
2600     m_client.dispatchDidDispatchOnloadEvents();
2601
2602     if (documentLoader())
2603         documentLoader()->dispatchOnloadEvents();
2604 }
2605
2606 void FrameLoader::frameDetached()
2607 {
2608     // Calling stopAllLoaders() can cause the frame to be deallocated, including the frame loader.
2609     Ref<Frame> protectedFrame(m_frame);
2610
2611     if (m_frame.document()->pageCacheState() != Document::InPageCache) {
2612         stopAllLoaders();
2613         m_frame.document()->stopActiveDOMObjects();
2614     }
2615
2616     detachFromParent();
2617 }
2618
2619 void FrameLoader::detachFromParent()
2620 {
2621     // Calling stopAllLoaders() can cause the frame to be deallocated, including the frame loader.
2622     Ref<Frame> protect(m_frame);
2623
2624     closeURL();
2625     history().saveScrollPositionAndViewStateToItem(history().currentItem());
2626     detachChildren();
2627     if (m_frame.document()->pageCacheState() != Document::InPageCache) {
2628         // stopAllLoaders() needs to be called after detachChildren() if the document is not in the page cache,
2629         // because detachedChildren() will trigger the unload event handlers of any child frames, and those event
2630         // handlers might start a new subresource load in this frame.
2631         stopAllLoaders();
2632     }
2633
2634     InspectorInstrumentation::frameDetachedFromParent(m_frame);
2635
2636     detachViewsAndDocumentLoader();
2637
2638     m_progressTracker = nullptr;
2639
2640     if (Frame* parent = m_frame.tree().parent()) {
2641         parent->loader().closeAndRemoveChild(m_frame);
2642         parent->loader().scheduleCheckCompleted();
2643         parent->loader().scheduleCheckLoadComplete();
2644     } else {
2645         m_frame.setView(nullptr);
2646         m_frame.willDetachPage();
2647         m_frame.detachFromPage();
2648     }
2649 }
2650
2651 void FrameLoader::detachViewsAndDocumentLoader()
2652 {
2653     m_client.detachedFromParent2();
2654     setDocumentLoader(nullptr);
2655     m_client.detachedFromParent3();
2656 }
2657     
2658 void FrameLoader::addExtraFieldsToSubresourceRequest(ResourceRequest& request)
2659 {
2660     addExtraFieldsToRequest(request, m_loadType, false);
2661 }
2662
2663 void FrameLoader::addExtraFieldsToMainResourceRequest(ResourceRequest& request)
2664 {
2665     // FIXME: Using m_loadType seems wrong for some callers.
2666     // If we are only preparing to load the main resource, that is previous load's load type!
2667     addExtraFieldsToRequest(request, m_loadType, true);
2668
2669     // Upgrade-Insecure-Requests should only be added to main resource requests
2670     addHTTPUpgradeInsecureRequestsIfNeeded(request);
2671 }
2672
2673 ResourceRequestCachePolicy FrameLoader::defaultRequestCachingPolicy(const ResourceRequest& request, FrameLoadType loadType, bool isMainResource)
2674 {
2675     if (m_overrideCachePolicyForTesting)
2676         return m_overrideCachePolicyForTesting.value();
2677
2678     if (isMainResource) {
2679         if (isReload(loadType) || request.isConditional())
2680             return ReloadIgnoringCacheData;
2681
2682         return UseProtocolCachePolicy;
2683     }
2684
2685     if (request.isConditional())
2686         return ReloadIgnoringCacheData;
2687
2688     if (documentLoader()->isLoadingInAPISense()) {
2689         // If we inherit cache policy from a main resource, we use the DocumentLoader's
2690         // original request cache policy for two reasons:
2691         // 1. For POST requests, we mutate the cache policy for the main resource,
2692         //    but we do not want this to apply to subresources
2693         // 2. Delegates that modify the cache policy using willSendRequest: should
2694         //    not affect any other resources. Such changes need to be done
2695         //    per request.
2696         ResourceRequestCachePolicy mainDocumentOriginalCachePolicy = documentLoader()->originalRequest().cachePolicy();
2697         // 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.
2698         // This policy is set on initial request too, but should not be inherited.
2699         return (mainDocumentOriginalCachePolicy == ReturnCacheDataDontLoad) ? ReturnCacheDataElseLoad : mainDocumentOriginalCachePolicy;
2700     }
2701
2702     return UseProtocolCachePolicy;
2703 }
2704
2705 void FrameLoader::addExtraFieldsToRequest(ResourceRequest& request, FrameLoadType loadType, bool isMainResource)
2706 {
2707     // Don't set the cookie policy URL if it's already been set.
2708     // But make sure to set it on all requests regardless of protocol, as it has significance beyond the cookie policy (<rdar://problem/6616664>).
2709     if (request.firstPartyForCookies().isEmpty()) {
2710         if (isMainResource && m_frame.isMainFrame())
2711             request.setFirstPartyForCookies(request.url());
2712         else if (Document* document = m_frame.document())
2713             request.setFirstPartyForCookies(document->firstPartyForCookies());
2714     }
2715
2716     if (request.isSameSiteUnspecified()) {
2717         auto* initiator = m_frame.document();
2718         if (isMainResource) {
2719             auto* ownerFrame = m_frame.tree().parent();
2720             if (!ownerFrame)
2721                 ownerFrame = m_opener;
2722             if (ownerFrame)
2723                 initiator = ownerFrame->document();
2724             ASSERT(ownerFrame || m_frame.isMainFrame());
2725         }
2726         addSameSiteInfoToRequestIfNeeded(request, initiator);
2727         request.setIsTopSite(isMainResource && m_frame.isMainFrame());
2728     }
2729
2730     Page* page = frame().page();
2731     bool hasSpecificCachePolicy = request.cachePolicy() != UseProtocolCachePolicy;
2732
2733     if (page && page->isResourceCachingDisabled()) {
2734         request.setCachePolicy(ReloadIgnoringCacheData);
2735         loadType = FrameLoadType::ReloadFromOrigin;
2736     } else if (!hasSpecificCachePolicy)
2737         request.setCachePolicy(defaultRequestCachingPolicy(request, loadType, isMainResource));
2738
2739     // The remaining modifications are only necessary for HTTP and HTTPS.
2740     if (!request.url().isEmpty() && !request.url().protocolIsInHTTPFamily())
2741         return;
2742
2743     if (!hasSpecificCachePolicy && request.cachePolicy() == ReloadIgnoringCacheData) {
2744         if (loadType == FrameLoadType::Reload)
2745             request.setHTTPHeaderField(HTTPHeaderName::CacheControl, "max-age=0");
2746         else if (loadType == FrameLoadType::ReloadFromOrigin) {
2747             request.setHTTPHeaderField(HTTPHeaderName::CacheControl, "no-cache");
2748             request.setHTTPHeaderField(HTTPHeaderName::Pragma, "no-cache");
2749         }
2750     }
2751
2752     if (m_overrideResourceLoadPriorityForTesting)
2753         request.setPriority(m_overrideResourceLoadPriorityForTesting.value());
2754
2755     applyUserAgentIfNeeded(request);
2756
2757     if (isMainResource)
2758         request.setHTTPAccept(defaultAcceptHeader);
2759
2760     // Make sure we send the Origin header.
2761     addHTTPOriginIfNeeded(request, String());
2762
2763     // Only set fallback array if it's still empty (later attempts may be incorrect, see bug 117818).
2764     if (request.responseContentDispositionEncodingFallbackArray().isEmpty()) {
2765         // Always try UTF-8. If that fails, try frame encoding (if any) and then the default.
2766         request.setResponseContentDispositionEncodingFallbackArray("UTF-8", m_frame.document()->encoding(), m_frame.settings().defaultTextEncodingName());
2767     }
2768 }
2769
2770 void FrameLoader::addHTTPOriginIfNeeded(ResourceRequest& request, const String& origin)
2771 {
2772     if (!request.httpOrigin().isEmpty())
2773         return;  // Request already has an Origin header.
2774
2775     // Don't send an Origin header for GET or HEAD to avoid privacy issues.
2776     // For example, if an intranet page has a hyperlink to an external web
2777     // site, we don't want to include the Origin of the request because it
2778     // will leak the internal host name. Similar privacy concerns have lead
2779     // to the widespread suppression of the Referer header at the network
2780     // layer.
2781     if (request.httpMethod() == "GET" || request.httpMethod() == "HEAD")
2782         return;
2783
2784     // For non-GET and non-HEAD methods, always send an Origin header so the
2785     // server knows we support this feature.
2786
2787     if (origin.isEmpty()) {
2788         // If we don't know what origin header to attach, we attach the value
2789         // for an empty origin.
2790         request.setHTTPOrigin(SecurityOrigin::createUnique()->toString());
2791         return;
2792     }
2793
2794     request.setHTTPOrigin(origin);
2795 }
2796
2797 // 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>.
2798 // The algorithm is ammended to treat URLs that inherit their security origin from their owner (e.g. about:blank)
2799 // as same-site. This matches the behavior of Chrome and Firefox.
2800 void FrameLoader::addSameSiteInfoToRequestIfNeeded(ResourceRequest& request, const Document* initiator)
2801 {
2802     if (!request.isSameSiteUnspecified())
2803         return;
2804     if (!initiator) {
2805         request.setIsSameSite(true);
2806         return;
2807     }
2808     if (SecurityPolicy::shouldInheritSecurityOriginFromOwner(request.url())) {
2809         request.setIsSameSite(true);
2810         return;
2811     }
2812     request.setIsSameSite(registrableDomainsAreEqual(initiator->firstPartyForSameSiteCookies(), request.url()));
2813 }
2814
2815 void FrameLoader::addHTTPUpgradeInsecureRequestsIfNeeded(ResourceRequest& request)
2816 {
2817     if (request.url().protocolIs("https")) {
2818         // FIXME: Identify HSTS cases and avoid adding the header. <https://bugs.webkit.org/show_bug.cgi?id=157885>
2819         return;
2820     }
2821
2822     request.setHTTPHeaderField(HTTPHeaderName::UpgradeInsecureRequests, ASCIILiteral("1"));
2823 }
2824
2825 void FrameLoader::loadPostRequest(FrameLoadRequest&& request, const String& referrer, FrameLoadType loadType, Event* event, FormState* formState, CompletionHandler<void()>&& completionHandler)
2826 {
2827     String frameName = request.frameName();
2828     LockHistory lockHistory = request.lockHistory();
2829     AllowNavigationToInvalidURL allowNavigationToInvalidURL = request.allowNavigationToInvalidURL();
2830     NewFrameOpenerPolicy openerPolicy = request.newFrameOpenerPolicy();
2831
2832     const ResourceRequest& inRequest = request.resourceRequest();
2833     const URL& url = inRequest.url();
2834     const String& contentType = inRequest.httpContentType();
2835     String origin = inRequest.httpOrigin();
2836
2837     ResourceRequest workingResourceRequest(url);    
2838
2839     if (!referrer.isEmpty())
2840         workingResourceRequest.setHTTPReferrer(referrer);
2841     workingResourceRequest.setHTTPOrigin(origin);
2842     workingResourceRequest.setHTTPMethod("POST");
2843     workingResourceRequest.setHTTPBody(inRequest.httpBody());
2844     workingResourceRequest.setHTTPContentType(contentType);
2845     addExtraFieldsToRequest(workingResourceRequest, loadType, true);
2846
2847     if (Document* document = m_frame.document())
2848         document->contentSecurityPolicy()->upgradeInsecureRequestIfNeeded(workingResourceRequest, ContentSecurityPolicy::InsecureRequestType::Load);
2849
2850     NavigationAction action { request.requester(), workingResourceRequest, request.initiatedByMainFrame(), loadType, true, event, request.shouldOpenExternalURLsPolicy(), request.downloadAttribute() };
2851
2852     if (!frameName.isEmpty()) {
2853         // The search for a target frame is done earlier in the case of form submission.
2854         if (Frame* targetFrame = formState ? 0 : findFrameForNavigation(frameName)) {
2855             targetFrame->loader().loadWithNavigationAction(workingResourceRequest, action, lockHistory, loadType, WTFMove(formState), allowNavigationToInvalidURL, WTFMove(completionHandler));
2856             return;
2857         }
2858
2859         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) {
2860             continueLoadAfterNewWindowPolicy(request, formState, frameName, action, shouldContinue, allowNavigationToInvalidURL, openerPolicy);
2861             completionHandler();
2862         });
2863         return;
2864     }
2865
2866     // must grab this now, since this load may stop the previous load and clear this flag
2867     bool isRedirect = m_quickRedirectComing;
2868     loadWithNavigationAction(workingResourceRequest, action, lockHistory, loadType, WTFMove(formState), allowNavigationToInvalidURL, [this, isRedirect, protectedFrame = makeRef(m_frame), completionHandler = WTFMove(completionHandler)] {
2869         if (isRedirect) {
2870             m_quickRedirectComing = false;
2871             if (m_provisionalDocumentLoader)
2872                 m_provisionalDocumentLoader->setIsClientRedirect(true);
2873             else if (m_policyDocumentLoader)
2874                 m_policyDocumentLoader->setIsClientRedirect(true);
2875         }
2876         completionHandler();
2877     });
2878 }
2879
2880 unsigned long FrameLoader::loadResourceSynchronously(const ResourceRequest& request, ClientCredentialPolicy clientCredentialPolicy, const FetchOptions& options, const HTTPHeaderMap& originalRequestHeaders, ResourceError& error, ResourceResponse& response, RefPtr<SharedBuffer>& data)
2881 {
2882     ASSERT(m_frame.document());
2883     String referrer = SecurityPolicy::generateReferrerHeader(m_frame.document()->referrerPolicy(), request.url(), outgoingReferrer());
2884     
2885     ResourceRequest initialRequest = request;
2886     initialRequest.setTimeoutInterval(10);
2887     
2888     if (!referrer.isEmpty())
2889         initialRequest.setHTTPReferrer(referrer);
2890     addHTTPOriginIfNeeded(initialRequest, outgoingOrigin());
2891
2892     initialRequest.setFirstPartyForCookies(m_frame.mainFrame().loader().documentLoader()->request().url());
2893     
2894     addExtraFieldsToSubresourceRequest(initialRequest);
2895
2896     unsigned long identifier = 0;    
2897     ResourceRequest newRequest(initialRequest);
2898     requestFromDelegate(newRequest, identifier, error);
2899
2900 #if ENABLE(CONTENT_EXTENSIONS)
2901     if (error.isNull()) {
2902         if (auto* page = m_frame.page()) {
2903             if (m_documentLoader) {
2904                 auto blockedStatus = page->userContentProvider().processContentExtensionRulesForLoad(newRequest.url(), ResourceType::Raw, *m_documentLoader);
2905                 applyBlockedStatusToRequest(blockedStatus, page, newRequest);
2906                 if (blockedStatus.blockedLoad) {
2907                     newRequest = { };
2908                     error = ResourceError(errorDomainWebKitInternal, 0, initialRequest.url(), emptyString());
2909                     response = { };
2910                     data = nullptr;
2911                 }
2912             }
2913         }
2914     }
2915 #endif
2916
2917     m_frame.document()->contentSecurityPolicy()->upgradeInsecureRequestIfNeeded(newRequest, ContentSecurityPolicy::InsecureRequestType::Load);
2918     
2919     if (error.isNull()) {
2920         ASSERT(!newRequest.isNull());
2921
2922         if (!documentLoader()->applicationCacheHost().maybeLoadSynchronously(newRequest, error, response, data)) {
2923             Vector<char> buffer;
2924             platformStrategies()->loaderStrategy()->loadResourceSynchronously(*this, identifier, newRequest, clientCredentialPolicy, options, originalRequestHeaders, error, response, buffer);
2925             data = SharedBuffer::create(WTFMove(buffer));
2926             documentLoader()->applicationCacheHost().maybeLoadFallbackSynchronously(newRequest, error, response, data);
2927             ResourceLoadObserver::shared().logSubresourceLoading(&m_frame, newRequest, response);
2928         }
2929     }
2930     notifier().sendRemainingDelegateMessages(m_documentLoader.get(), identifier, request, response, data ? data->data() : nullptr, data ? data->size() : 0, -1, error);
2931     return identifier;
2932 }
2933
2934 const ResourceRequest& FrameLoader::originalRequest() const
2935 {
2936     return activeDocumentLoader()->originalRequestCopy();
2937 }
2938
2939 void FrameLoader::receivedMainResourceError(const ResourceError& error)
2940 {
2941     // Retain because the stop may release the last reference to it.
2942     Ref<Frame> protect(m_frame);
2943
2944     RefPtr<DocumentLoader> loader = activeDocumentLoader();
2945     // FIXME: Don't want to do this if an entirely new load is going, so should check
2946     // that both data sources on the frame are either this or nil.
2947     stop();
2948     if (m_client.shouldFallBack(error))
2949         handleFallbackContent();
2950
2951     if (m_state == FrameStateProvisional && m_provisionalDocumentLoader) {
2952         if (m_submittedFormURL == m_provisionalDocumentLoader->originalRequestCopy().url())
2953             m_submittedFormURL = URL();
2954             
2955         // We might have made a page cache item, but now we're bailing out due to an error before we ever
2956         // transitioned to the new page (before WebFrameState == commit).  The goal here is to restore any state
2957         // so that the existing view (that wenever got far enough to replace) can continue being used.
2958         history().invalidateCurrentItemCachedPage();
2959         
2960         // Call clientRedirectCancelledOrFinished here so that the frame load delegate is notified that the redirect's
2961         // status has changed, if there was a redirect. The frame load delegate may have saved some state about
2962         // the redirect in its -webView:willPerformClientRedirectToURL:delay:fireDate:forFrame:. Since we are definitely
2963         // not going to use this provisional resource, as it was cancelled, notify the frame load delegate that the redirect
2964         // has ended.
2965         if (m_sentRedirectNotification)
2966             clientRedirectCancelledOrFinished(false);
2967     }
2968
2969     checkCompleted();
2970     if (m_frame.page())
2971         checkLoadComplete();
2972 }
2973
2974 void FrameLoader::continueFragmentScrollAfterNavigationPolicy(const ResourceRequest& request, bool shouldContinue)
2975 {
2976     m_quickRedirectComing = false;
2977
2978     if (!shouldContinue)
2979         return;
2980
2981     // Calling stopLoading() on the provisional document loader can cause the underlying
2982     // frame to be deallocated.
2983     Ref<Frame> protectedFrame(m_frame);
2984
2985     // If we have a provisional request for a different document, a fragment scroll should cancel it.
2986     if (m_provisionalDocumentLoader && !equalIgnoringFragmentIdentifier(m_provisionalDocumentLoader->request().url(), request.url())) {
2987         m_provisionalDocumentLoader->stopLoading();
2988         setProvisionalDocumentLoader(nullptr);
2989     }
2990
2991     bool isRedirect = m_quickRedirectComing || policyChecker().loadType() == FrameLoadType::RedirectWithLockedBackForwardList;
2992     loadInSameDocument(request.url(), 0, !isRedirect);
2993 }
2994
2995 bool FrameLoader::shouldPerformFragmentNavigation(bool isFormSubmission, const String& httpMethod, FrameLoadType loadType, const URL& url)
2996 {
2997     // We don't do this if we are submitting a form with method other than "GET", explicitly reloading,
2998     // currently displaying a frameset, or if the URL does not have a fragment.
2999     // These rules were originally based on what KHTML was doing in KHTMLPart::openURL.
3000
3001     // FIXME: What about load types other than Standard and Reload?
3002
3003     return (!isFormSubmission || equalLettersIgnoringASCIICase(httpMethod, "get"))
3004         && !isReload(loadType)
3005         && loadType != FrameLoadType::Same
3006         && !shouldReload(m_frame.document()->url(), url)
3007         // We don't want to just scroll if a link from within a
3008         // frameset is trying to reload the frameset into _top.
3009         && !m_frame.document()->isFrameSet();
3010 }
3011
3012 static bool itemAllowsScrollRestoration(HistoryItem* historyItem)
3013 {
3014     return !historyItem || historyItem->shouldRestoreScrollPosition();
3015 }
3016
3017 static bool isSameDocumentReload(bool isNewNavigation, FrameLoadType loadType)
3018 {
3019     return !isNewNavigation && !isBackForwardLoadType(loadType);
3020 }
3021
3022 void FrameLoader::scrollToFragmentWithParentBoundary(const URL& url, bool isNewNavigation)
3023 {
3024     FrameView* view = m_frame.view();
3025     if (!view)
3026         return;
3027
3028     // Leaking scroll position to a cross-origin ancestor would permit the so-called "framesniffing" attack.
3029     RefPtr<Frame> boundaryFrame(url.hasFragmentIdentifier() ? m_frame.document()->findUnsafeParentScrollPropagationBoundary() : 0);
3030
3031     if (boundaryFrame)
3032         boundaryFrame->view()->setSafeToPropagateScrollToParent(false);
3033
3034     if (isSameDocumentReload(isNewNavigation, m_loadType) || itemAllowsScrollRestoration(history().currentItem()))
3035         view->scrollToFragment(url);
3036
3037     if (boundaryFrame)
3038         boundaryFrame->view()->setSafeToPropagateScrollToParent(true);
3039 }
3040
3041 bool FrameLoader::shouldClose()
3042 {
3043     Page* page = m_frame.page();
3044     if (!page)
3045         return true;
3046     if (!page->chrome().canRunBeforeUnloadConfirmPanel())
3047         return true;
3048
3049     // Store all references to each subframe in advance since beforeunload's event handler may modify frame
3050     Vector<Ref<Frame>, 16> targetFrames;
3051     targetFrames.append(m_frame);
3052     for (Frame* child = m_frame.tree().firstChild(); child; child = child->tree().traverseNext(&m_frame))
3053         targetFrames.append(*child);
3054
3055     bool shouldClose = false;
3056     {
3057         NavigationDisabler navigationDisabler(&m_frame);
3058         size_t i;
3059
3060         for (i = 0; i < targetFrames.size(); i++) {
3061             if (!targetFrames[i]->tree().isDescendantOf(&m_frame))
3062                 continue;
3063             if (!targetFrames[i]->loader().dispatchBeforeUnloadEvent(page->chrome(), this))
3064                 break;
3065         }
3066
3067         if (i == targetFrames.size())
3068             shouldClose = true;
3069     }
3070
3071     if (!shouldClose)
3072         m_submittedFormURL = URL();
3073
3074     m_currentNavigationHasShownBeforeUnloadConfirmPanel = false;
3075     return shouldClose;
3076 }
3077
3078 void FrameLoader::dispatchUnloadEvents(UnloadEventPolicy unloadEventPolicy)
3079 {
3080     if (!m_frame.document())
3081         return;
3082
3083     // We store the frame's page in a local variable because the frame might get detached inside dispatchEvent.
3084     ForbidPromptsScope forbidPrompts(m_frame.page());
3085     IgnoreOpensDuringUnloadCountIncrementer ignoreOpensDuringUnloadCountIncrementer(m_frame.document());
3086
3087     if (m_didCallImplicitClose && !m_wasUnloadEventEmitted) {
3088         auto* currentFocusedElement = m_frame.document()->focusedElement();
3089         if (is<HTMLInputElement>(currentFocusedElement))
3090             downcast<HTMLInputElement>(*currentFocusedElement).endEditing();
3091         if (m_pageDismissalEventBeingDispatched == PageDismissalType::None) {
3092             if (unloadEventPolicy == UnloadEventPolicyUnloadAndPageHide) {
3093                 m_pageDismissalEventBeingDispatched = PageDismissalType::PageHide;
3094                 m_frame.document()->domWindow()->dispatchEvent(PageTransitionEvent::create(eventNames().pagehideEvent, m_frame.document()->pageCacheState() == Document::AboutToEnterPageCache), m_frame.document());
3095             }
3096
3097             // FIXME: update Page Visibility state here.
3098             // https://bugs.webkit.org/show_bug.cgi?id=116770
3099
3100             if (m_frame.document()->pageCacheState() == Document::NotInPageCache) {
3101                 Ref<Event> unloadEvent(Event::create(eventNames().unloadEvent, false, false));
3102                 // The DocumentLoader (and thus its LoadTiming) might get destroyed
3103                 // while dispatching the event, so protect it to prevent writing the end
3104                 // time into freed memory.
3105                 RefPtr<DocumentLoader> documentLoader = m_provisionalDocumentLoader;
3106                 m_pageDismissalEventBeingDispatched = PageDismissalType::Unload;
3107                 if (documentLoader && documentLoader->timing().startTime() && !documentLoader->timing().unloadEventStart() && !documentLoader->timing().unloadEventEnd()) {
3108                     auto& timing = documentLoader->timing();
3109                     timing.markUnloadEventStart();
3110                     m_frame.document()->domWindow()->dispatchEvent(unloadEvent, m_frame.document());
3111                     timing.markUnloadEventEnd();
3112                 } else
3113                     m_frame.document()->domWindow()->dispatchEvent(unloadEvent, m_frame.document());
3114             }
3115         }
3116         m_pageDismissalEventBeingDispatched = PageDismissalType::None;
3117         m_wasUnloadEventEmitted = true;
3118     }
3119
3120     // Dispatching the unload event could have made m_frame.document() null.
3121     if (!m_frame.document())
3122         return;
3123
3124     if (m_frame.document()->pageCacheState() != Document::NotInPageCache)
3125         return;
3126
3127     // Don't remove event listeners from a transitional empty document (see bug 28716 for more information).
3128     bool keepEventListeners = m_stateMachine.isDisplayingInitialEmptyDocument() && m_provisionalDocumentLoader
3129         && m_frame.document()->isSecureTransitionTo(m_provisionalDocumentLoader->url());
3130
3131     if (!keepEventListeners)
3132         m_frame.document()->removeAllEventListeners();
3133 }
3134
3135 static bool shouldAskForNavigationConfirmation(Document& document, const BeforeUnloadEvent& event)
3136 {
3137     // Confirmation dialog should not be displayed when the allow-modals flag is not set.
3138     if (document.isSandboxed(SandboxModals))
3139         return false;
3140
3141     bool userDidInteractWithPage = document.topDocument().userDidInteractWithPage();
3142     // Web pages can request we ask for confirmation before navigating by:
3143     // - Cancelling the BeforeUnloadEvent (modern way)
3144     // - Setting the returnValue attribute on the BeforeUnloadEvent to a non-empty string.
3145     // - Returning a non-empty string from the event handler, which is then set as returnValue
3146     //   attribute on the BeforeUnloadEvent.
3147     return userDidInteractWithPage && (event.defaultPrevented() || !event.returnValue().isEmpty());
3148 }
3149
3150 bool FrameLoader::dispatchBeforeUnloadEvent(Chrome& chrome, FrameLoader* frameLoaderBeingNavigated)
3151 {
3152     DOMWindow* domWindow = m_frame.document()->domWindow();
3153     if (!domWindow)
3154         return true;
3155
3156     RefPtr<Document> document = m_frame.document();
3157     if (!document->bodyOrFrameset())
3158         return true;
3159     
3160     Ref<BeforeUnloadEvent> beforeUnloadEvent = BeforeUnloadEvent::create();
3161     m_pageDismissalEventBeingDispatched = PageDismissalType::BeforeUnload;
3162
3163     {
3164         ForbidPromptsScope forbidPrompts(m_frame.page());
3165         IgnoreOpensDuringUnloadCountIncrementer ignoreOpensDuringUnloadCountIncrementer(m_frame.document());
3166         domWindow->dispatchEvent(beforeUnloadEvent, domWindow->document());
3167     }
3168
3169     m_pageDismissalEventBeingDispatched = PageDismissalType::None;
3170
3171     if (!beforeUnloadEvent->defaultPrevented())
3172         document->defaultEventHandler(beforeUnloadEvent.get());
3173
3174     if (!shouldAskForNavigationConfirmation(*document, beforeUnloadEvent))
3175         return true;
3176
3177     // If the navigating FrameLoader has already shown a beforeunload confirmation panel for the current navigation attempt,
3178     // this frame is not allowed to cause another one to be shown.
3179     if (frameLoaderBeingNavigated->m_currentNavigationHasShownBeforeUnloadConfirmPanel) {
3180         document->addConsoleMessage(MessageSource::JS, MessageLevel::Error, ASCIILiteral("Blocked attempt to show multiple beforeunload confirmation dialogs for the same navigation."));
3181         return true;
3182     }
3183
3184     // We should only display the beforeunload dialog for an iframe if its SecurityOrigin matches all
3185     // ancestor frame SecurityOrigins up through the navigating FrameLoader.
3186     if (frameLoaderBeingNavigated != this) {
3187         Frame* parentFrame = m_frame.tree().parent();
3188         while (parentFrame) {
3189             Document* parentDocument = parentFrame->document();
3190             if (!parentDocument)
3191                 return true;
3192             if (!m_frame.document() || !m_frame.document()->securityOrigin().canAccess(parentDocument->securityOrigin())) {
3193                 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."));
3194                 return true;
3195             }
3196             
3197             if (&parentFrame->loader() == frameLoaderBeingNavigated)
3198                 break;
3199             
3200             parentFrame = parentFrame->tree().parent();
3201         }
3202         
3203         // The navigatingFrameLoader should always be in our ancestory.
3204         ASSERT(parentFrame);
3205         ASSERT(&parentFrame->loader() == frameLoaderBeingNavigated);
3206     }
3207
3208     frameLoaderBeingNavigated->m_currentNavigationHasShownBeforeUnloadConfirmPanel = true;
3209
3210     String text = document->displayStringModifiedByEncoding(beforeUnloadEvent->returnValue());
3211     return chrome.runBeforeUnloadConfirmPanel(text, m_frame);
3212 }
3213
3214 void FrameLoader::continueLoadAfterNavigationPolicy(const ResourceRequest& request, FormState* formState, ShouldContinue shouldContinue, AllowNavigationToInvalidURL allowNavigationToInvalidURL)
3215 {
3216     // If we loaded an alternate page to replace an unreachableURL, we'll get in here with a
3217     // nil policyDataSource because loading the alternate page will have passed
3218     // through this method already, nested; otherwise, policyDataSource should still be set.
3219     ASSERT(m_policyDocumentLoader || !m_provisionalDocumentLoader->unreachableURL().isEmpty());
3220
3221     bool isTargetItem = history().provisionalItem() ? history().provisionalItem()->isTargetItem() : false;
3222
3223     bool urlIsDisallowed = allowNavigationToInvalidURL == AllowNavigationToInvalidURL::No && !request.url().isValid();
3224     bool canContinue = shouldContinue != ShouldContinue::No && shouldClose() && !urlIsDisallowed;
3225
3226     if (!canContinue) {
3227         // If we were waiting for a quick redirect, but the policy delegate decided to ignore it, then we 
3228         // need to report that the client redirect was cancelled.
3229         // FIXME: The client should be told about ignored non-quick redirects, too.
3230         if (m_quickRedirectComing)
3231             clientRedirectCancelledOrFinished(false);
3232
3233         setPolicyDocumentLoader(nullptr);
3234         checkCompleted();
3235         checkLoadComplete();
3236
3237         // If the navigation request came from the back/forward menu, and we punt on it, we have the 
3238         // problem that we have optimistically moved the b/f cursor already, so move it back. For sanity,
3239         // we only do this when punting a navigation for the target frame or top-level frame.  
3240         if ((isTargetItem || m_frame.isMainFrame()) && isBackForwardLoadType(policyChecker().loadType())) {
3241             if (Page* page = m_frame.page()) {
3242                 if (HistoryItem* resetItem = m_frame.mainFrame().loader().history().currentItem()) {
3243                     page->backForward().setCurrentItem(resetItem);
3244                     m_frame.loader().client().updateGlobalHistoryItemForPage();
3245                 }
3246             }
3247         }
3248         return;
3249     }
3250
3251     FrameLoadType type = policyChecker().loadType();
3252     // A new navigation is in progress, so don't clear the history's provisional item.
3253     stopAllLoaders(ShouldNotClearProvisionalItem);
3254     
3255     // <rdar://problem/6250856> - In certain circumstances on pages with multiple frames, stopAllLoaders()
3256     // might detach the current FrameLoader, in which case we should bail on this newly defunct load. 
3257     if (!m_frame.page())
3258         return;
3259
3260     setProvisionalDocumentLoader(m_policyDocumentLoader.get());
3261     m_loadType = type;
3262     setState(FrameStateProvisional);
3263
3264     setPolicyDocumentLoader(nullptr);
3265
3266     if (isBackForwardLoadType(type)) {
3267         auto& diagnosticLoggingClient = m_frame.page()->diagnosticLoggingClient();
3268         if (history().provisionalItem()->isInPageCache()) {
3269             diagnosticLoggingClient.logDiagnosticMessageWithResult(DiagnosticLoggingKeys::pageCacheKey(), DiagnosticLoggingKeys::retrievalKey(), DiagnosticLoggingResultPass, ShouldSample::Yes);
3270             loadProvisionalItemFromCachedPage();
3271             return;
3272         }
3273         diagnosticLoggingClient.logDiagnosticMessageWithResult(DiagnosticLoggingKeys::pageCacheKey(), DiagnosticLoggingKeys::retrievalKey(), DiagnosticLoggingResultFail, ShouldSample::Yes);
3274     }
3275
3276     CompletionHandler<void(void)> completionHandler = [this, shouldContinue] {
3277         if (!m_provisionalDocumentLoader)
3278             return;
3279         
3280         prepareForLoadStart();
3281         
3282         // The load might be cancelled inside of prepareForLoadStart(), nulling out the m_provisionalDocumentLoader,
3283         // so we need to null check it again.
3284         if (!m_provisionalDocumentLoader) {
3285             RELEASE_LOG_IF_ALLOWED("dispatchWillSubmitForm completionHandler: Frame load canceled (frame = %p, main = %d)", &m_frame, m_frame.isMainFrame());
3286             return;
3287         }
3288         
3289         DocumentLoader* activeDocLoader = activeDocumentLoader();
3290         if (activeDocLoader && activeDocLoader->isLoadingMainResource()) {
3291             RELEASE_LOG_IF_ALLOWED("dispatchWillSubmitForm completionHandler: Main frame already being loaded (frame = %p, main = %d)", &m_frame, m_frame.isMainFrame());
3292             return;
3293         }
3294         
3295         m_loadingFromCachedPage = false;
3296
3297         // We handle suspension by navigating forward to about:blank, which leaves us setup to navigate back to resume.
3298         if (shouldContinue == ShouldContinue::ForSuspension)
3299             m_provisionalDocumentLoader->willContinueMainResourceLoadAfterRedirect({ blankURL() });
3300
3301         m_provisionalDocumentLoader->startLoadingMainResource(shouldContinue);
3302     };
3303     
3304     if (!formState) {
3305         completionHandler();
3306         return;
3307     }
3308
3309     m_client.dispatchWillSubmitForm(*formState, WTFMove(completionHandler));
3310 }
3311
3312 void FrameLoader::continueLoadAfterNewWindowPolicy(const ResourceRequest& request,
3313     FormState* formState, const String& frameName, const NavigationAction& action, ShouldContinue shouldContinue, AllowNavigationToInvalidURL allowNavigationToInvalidURL, NewFrameOpenerPolicy openerPolicy)
3314 {
3315     ASSERT(shouldContinue != ShouldContinue::ForSuspension);
3316     if (shouldContinue != ShouldContinue::Yes)
3317         return;
3318
3319     Ref<Frame> frame(m_frame);
3320     RefPtr<Frame> mainFrame = m_client.dispatchCreatePage(action);
3321     if (!mainFrame)
3322         return;
3323
3324     SandboxFlags sandboxFlags = frame->loader().effectiveSandboxFlags();
3325     if (sandboxFlags & SandboxPropagatesToAuxiliaryBrowsingContexts)
3326         mainFrame->loader().forceSandboxFlags(sandboxFlags);
3327
3328     if (!equalIgnoringASCIICase(frameName, "_blank"))
3329         mainFrame->tree().setName(frameName);
3330
3331     mainFrame->page()->setOpenedByDOM();
3332     mainFrame->loader().m_client.dispatchShow();
3333     if (openerPolicy == NewFrameOpenerPolicy::Allow) {
3334         mainFrame->loader().setOpener(frame.ptr());
3335         mainFrame->document()->setReferrerPolicy(frame->document()->referrerPolicy());
3336     }
3337
3338     NavigationAction newAction { *frame->document(), request, InitiatedByMainFrame::Unknown, NavigationType::Other, action.shouldOpenExternalURLsPolicy() };
3339     mainFrame->loader().loadWithNavigationAction(request, newAction, LockHistory::No, FrameLoadType::Standard, formState, allowNavigationToInvalidURL, [] { });
3340 }
3341
3342 void FrameLoader::requestFromDelegate(ResourceRequest& request, unsigned long& identifier, ResourceError& error)
3343 {
3344     ASSERT(!request.isNull());
3345
3346     identifier = 0;
3347     if (Page* page = m_frame.page()) {
3348         identifier = page->progress().createUniqueIdentifier();
3349         notifier().assignIdentifierToInitialRequest(identifier, m_documentLoader.get(), request);
3350     }
3351
3352     ResourceRequest newRequest(request);
3353     notifier().dispatchWillSendRequest(m_documentLoader.get(), identifier, newRequest, ResourceResponse());
3354
3355     if (newRequest.isNull())
3356         error = cancelledError(request);
3357     else
3358         error = ResourceError();
3359
3360     request = newRequest;
3361 }
3362
3363 void FrameLoader::loadedResourceFromMemoryCache(CachedResource& resource, ResourceRequest& newRequest, ResourceError& error)
3364 {
3365     Page* page = m_frame.page();
3366     if (!page)
3367         return;
3368
3369     if (!resource.shouldSendResourceLoadCallbacks() || m_documentLoader->haveToldClientAboutLoad(resource.url()))
3370         return;
3371
3372     // Main resource delegate messages are synthesized in MainResourceLoader, so we must not send them here.
3373     if (resource.type() == CachedResource::MainResource)
3374         return;
3375
3376     if (!page->areMemoryCacheClientCallsEnabled()) {
3377         InspectorInstrumentation::didLoadResourceFromMemoryCache(*page, m_documentLoader.get(), &resource);
3378         m_documentLoader->recordMemoryCacheLoadForFutureClientNotification(resource.resourceRequest());
3379         m_documentLoader->didTellClientAboutLoad(resource.url());
3380         return;
3381     }
3382
3383     if (m_client.dispatchDidLoadResourceFromMemoryCache(m_documentLoader.get(), newRequest, resource.response(), resource.encodedSize())) {
3384         InspectorInstrumentation::didLoadResourceFromMemoryCache(*page, m_documentLoader.get(), &resource);
3385         m_documentLoader->didTellClientAboutLoad(resource.url());
3386         return;
3387     }
3388
3389     unsigned long identifier;
3390     requestFromDelegate(newRequest, identifier, error);
3391
3392     ResourceResponse response = resource.response();
3393     response.setSource(ResourceResponse::Source::MemoryCache);
3394     notifier().sendRemainingDelegateMessages(m_documentLoader.get(), identifier, newRequest, response, 0, resource.encodedSize(), 0, error);
3395 }
3396
3397 void FrameLoader::applyUserAgentIfNeeded(ResourceRequest& request)
3398 {
3399     if (!request.hasHTTPHeaderField(HTTPHeaderName::UserAgent)) {
3400         String userAgent = this->userAgent(request.url());
3401         ASSERT(!userAgent.isNull());
3402         request.setHTTPUserAgent(userAgent);
3403     }
3404 }
3405
3406 bool FrameLoader::shouldInterruptLoadForXFrameOptions(const String& content, const URL& url, unsigned long requestIdentifier)
3407 {
3408     Frame& topFrame = m_frame.tree().top();
3409     if (&m_frame == &topFrame)
3410         return false;
3411
3412     XFrameOptionsDisposition disposition = parseXFrameOptionsHeader(content);
3413
3414     switch (disposition) {
3415     case XFrameOptionsSameOrigin: {
3416         RefPtr<SecurityOrigin> origin = SecurityOrigin::create(url);
3417         if (!origin->isSameSchemeHostPort(topFrame.document()->securityOrigin()))
3418             return true;
3419         for (Frame* frame = m_frame.tree().parent(); frame; frame = frame->tree().parent()) {
3420             if (!origin->isSameSchemeHostPort(frame->document()->securityOrigin()))
3421                 break;
3422         }
3423         return false;
3424     }
3425     case XFrameOptionsDeny:
3426         return true;
3427     case XFrameOptionsAllowAll:
3428         return false;
3429     case XFrameOptionsConflict:
3430         m_frame.document()->addConsoleMessage(MessageSource::JS, MessageLevel::Error, "Multiple 'X-Frame-Options' headers with conflicting values ('" + content + "') encountered when loading '" + url.stringCenterEllipsizedToLength() + "'. Falling back to 'DENY'.", requestIdentifier);
3431         return true;
3432     case XFrameOptionsInvalid:
3433         m_frame.document()->addConsoleMessage(MessageSource::JS, MessageLevel::Error, "Invalid 'X-Frame-Options' header encountered when loading '" + url.stringCenterEllipsizedToLength() + "': '" + content + "' is not a recognized directive. The header will be ignored.", requestIdentifier);
3434         return false;
3435     case XFrameOptionsNone:
3436         return false;
3437     }
3438     ASSERT_NOT_REACHED();
3439     return false;
3440 }
3441
3442 void FrameLoader::loadProvisionalItemFromCachedPage()
3443 {
3444     DocumentLoader* provisionalLoader = provisionalDocumentLoader();
3445     LOG(PageCache, "WebCorePageCache: Loading provisional DocumentLoader %p with URL '%s' from CachedPage", provisionalDocumentLoader(), provisionalDocumentLoader()->url().stringCenterEllipsizedToLength().utf8().data());
3446
3447     prepareForLoadStart();
3448
3449     m_loadingFromCachedPage = true;
3450
3451     // Should have timing data from previous time(s) the page was shown.
3452     ASSERT(provisionalLoader->timing().startTime());
3453     provisionalLoader->resetTiming();
3454     provisionalLoader->timing().markStartTime();
3455
3456     provisionalLoader->setCommitted(true);
3457     commitProvisionalLoad();
3458 }
3459
3460 bool FrameLoader::shouldTreatURLAsSameAsCurrent(const URL& url) const
3461 {
3462     if (!history().currentItem())
3463         return false;
3464     return url == history().currentItem()->url() || url == history().currentItem()->originalURL();
3465 }
3466
3467 bool FrameLoader::shouldTreatURLAsSrcdocDocument(const URL& url) const
3468 {
3469     if (!equalLettersIgnoringASCIICase(url.string(), "about:srcdoc"))
3470         return false;
3471     HTMLFrameOwnerElement* ownerElement = m_frame.ownerElement();
3472     if (!ownerElement)
3473         return false;
3474     if (!ownerElement->hasTagName(iframeTag))
3475         return false;
3476     return ownerElement->hasAttributeWithoutSynchronization(srcdocAttr);
3477 }
3478
3479 Frame* FrameLoader::findFrameForNavigation(const AtomicString& name, Document* activeDocument)
3480 {
3481     Frame* frame = m_frame.tree().find(name);
3482
3483     // FIXME: Eventually all callers should supply the actual activeDocument so we can call canNavigate with the right document.
3484     if (!activeDocument)
3485         activeDocument = m_frame.document();
3486
3487     if (!activeDocument->canNavigate(frame))
3488         return nullptr;
3489
3490     return frame;
3491 }
3492
3493 void FrameLoader::loadSameDocumentItem(HistoryItem& item)
3494 {
3495     ASSERT(item.documentSequenceNumber() == history().currentItem()->documentSequenceNumber());
3496
3497     Ref<Frame> protect(m_frame);
3498
3499     // Save user view state to the current history item here since we don't do a normal load.
3500     // FIXME: Does form state need to be saved here too?
3501     history().saveScrollPositionAndViewStateToItem(history().currentItem());
3502     if (FrameView* view = m_frame.view())
3503         view->setWasScrolledByUser(false);
3504
3505     history().setCurrentItem(&item);
3506         
3507     // loadInSameDocument() actually changes the URL and notifies load delegates of a "fake" load
3508     loadInSameDocument(item.url(), item.stateObject(), false);
3509
3510     // Restore user view state from the current history item here since we don't do a normal load.
3511     history().restoreScrollPositionAndViewState();
3512 }
3513
3514 // FIXME: This function should really be split into a couple pieces, some of
3515 // which should be methods of HistoryController and some of which should be
3516 // methods of FrameLoader.
3517 void FrameLoader::loadDifferentDocumentItem(HistoryItem& item, FrameLoadType loadType, FormSubmissionCacheLoadPolicy cacheLoadPolicy, NavigationPolicyCheck navigationPolicyCheck)
3518 {
3519     // Remember this item so we can traverse any child items as child frames load
3520     history().setProvisionalItem(&item);
3521
3522     auto initiatedByMainFrame = InitiatedByMainFrame::Unknown;
3523
3524     SetForScope<bool> currentLoadShouldCheckNavigationPolicyGuard(m_currentLoadShouldCheckNavigationPolicy, navigationPolicyCheck != NavigationPolicyCheck::Bypass);
3525
3526     if (CachedPage* cachedPage = PageCache::singleton().get(item, m_frame.page())) {
3527         auto documentLoader = cachedPage->documentLoader();
3528         m_client.updateCachedDocumentLoader(*documentLoader);
3529         documentLoader->setTriggeringAction({ *m_frame.document(), documentLoader->request(), initiatedByMainFrame, loadType, false });
3530         documentLoader->setLastCheckedRequest(ResourceRequest());
3531         loadWithDocumentLoader(documentLoader, loadType, 0, AllowNavigationToInvalidURL::Yes, navigationPolicyCheck, [] { });
3532         return;
3533     }
3534
3535     URL itemURL = item.url();
3536     URL itemOriginalURL = item.originalURL();
3537     URL currentURL;
3538     if (documentLoader())
3539         currentURL = documentLoader()->url();
3540     RefPtr<FormData> formData = item.formData();
3541
3542     ResourceRequest request(itemURL);
3543
3544     if (!item.referrer().isNull())
3545         request.setHTTPReferrer(item.referrer());
3546
3547     ShouldOpenExternalURLsPolicy shouldOpenExternalURLsPolicy = shouldOpenExternalURLsPolicyToApply(m_frame, initiatedByMainFrame, item.shouldOpenExternalURLsPolicy());
3548     bool isFormSubmission = false;
3549     Event* event = nullptr;
3550
3551     // If this was a repost that failed the page cache, we might try to repost the form.
3552     NavigationAction action;
3553     if (formData) {
3554         formData->generateFiles(m_frame.document());
3555
3556         request.setHTTPMethod("POST");
3557         request.setHTTPBody(WTFMove(formData));
3558         request.setHTTPContentType(item.formContentType());
3559         RefPtr<SecurityOrigin> securityOrigin = SecurityOrigin::createFromString(item.referrer());
3560         addHTTPOriginIfNeeded(request, securityOrigin->toString());
3561         addHTTPUpgradeInsecureRequestsIfNeeded(request);
3562
3563         // Make sure to add extra fields to the request after the Origin header is added for the FormData case.
3564         // See https://bugs.webkit.org/show_bug.cgi?id=22194 for more discussion.
3565         addExtraFieldsToRequest(request, loadType, true);
3566         
3567         // FIXME: Slight hack to test if the NSURL cache contains the page we're going to.
3568         // We want to know this before talking to the policy delegate, since it affects whether 
3569         // we show the DoYouReallyWantToRepost nag.
3570         //
3571         // This trick has a small bug (3123893) where we might find a cache hit, but then
3572         // have the item vanish when we try to use it in the ensuing nav.  This should be
3573         // extremely rare, but in that case the user will get an error on the navigation.
3574         
3575         if (cacheLoadPolicy == MayAttemptCacheOnlyLoadForFormSubmissionItem) {
3576             request.setCachePolicy(ReturnCacheDataDontLoad);
3577             action = { *m_frame.document(), request, initiatedByMainFrame, loadType, isFormSubmission, event, shouldOpenExternalURLsPolicy };
3578         } else {
3579             request.setCachePolicy(ReturnCacheDataElseLoad);
3580             action = { *m_frame.document(), request, initiatedByMainFrame, NavigationType::FormResubmitted, shouldOpenExternalURLsPolicy, event };
3581         }
3582     } else {
3583         switch (loadType) {
3584         case FrameLoadType::Reload:
3585         case FrameLoadType::ReloadFromOrigin:
3586         case FrameLoadType::ReloadExpiredOnly:
3587             request.setCachePolicy(ReloadIgnoringCacheData);
3588             break;
3589         case FrameLoadType::Back:
3590         case FrameLoadType::Forward:
3591         case FrameLoadType::IndexedBackForward: {
3592 #if PLATFORM(COCOA)
3593             bool allowStaleData = true;
3594 #else
3595             bool allowStaleData = !item.wasRestoredFromSession();
3596 #endif
3597             if (allowStaleData)
3598                 request.setCachePolicy(ReturnCacheDataElseLoad);
3599             item.setWasRestoredFromSession(false);
3600             break;
3601         }
3602         case FrameLoadType::Standard:
3603         case FrameLoadType::RedirectWithLockedBackForwardList:
3604             break;
3605         case FrameLoadType::Same:
3606         case FrameLoadType::Replace:
3607             ASSERT_NOT_REACHED();
3608         }
3609
3610         addExtraFieldsToRequest(request, loadType, true);
3611
3612         ResourceRequest requestForOriginalURL(request);
3613         requestForOriginalURL.setURL(itemOriginalURL);
3614         action = { *m_frame.document(), requestForOriginalURL, initiatedByMainFrame, loadType, isFormSubmission, event, shouldOpenExternalURLsPolicy };
3615     }
3616
3617     loadWithNavigationAction(request, action, LockHistory::No, loadType, 0, AllowNavigationToInvalidURL::Yes, [] { });
3618 }
3619
3620 // Loads content into this frame, as specified by history item
3621 void FrameLoader::loadItem(HistoryItem& item, FrameLoadType loadType, NavigationPolicyCheck navigationPolicyCheck)
3622 {
3623     m_requestedHistoryItem = &item;
3624     HistoryItem* currentItem = history().currentItem();
3625     bool sameDocumentNavigation = currentItem && item.shouldDoSameDocumentNavigationTo(*currentItem);
3626
3627     if (sameDocumentNavigation)
3628         loadSameDocumentItem(item);
3629     else
3630         loadDifferentDocumentItem(item, loadType, MayAttemptCacheOnlyLoadForFormSubmissionItem, navigationPolicyCheck);
3631 }
3632
3633 void FrameLoader::retryAfterFailedCacheOnlyMainResourceLoad()
3634 {
3635     ASSERT(m_state == FrameStateProvisional);
3636     ASSERT(!m_loadingFromCachedPage);
3637     ASSERT(history().provisionalItem());
3638     ASSERT(history().provisionalItem()->formData());
3639     ASSERT(history().provisionalItem() == m_requestedHistoryItem.get());
3640
3641     FrameLoadType loadType = m_loadType;
3642     HistoryItem& item = *history().provisionalItem();
3643
3644     stopAllLoaders(ShouldNotClearProvisionalItem);
3645     loadDifferentDocumentItem(item, loadType, MayNotAttemptCacheOnlyLoadForFormSubmissionItem, NavigationPolicyCheck::Require);
3646 }
3647
3648 ResourceError FrameLoader::cancelledError(const ResourceRequest& request) const
3649 {
3650     ResourceError error = m_client.cancelledError(request);
3651     error.setType(ResourceError::Type::Cancellation);
3652     return error;
3653 }
3654
3655 ResourceError FrameLoader::blockedByContentBlockerError(const ResourceRequest& request) const
3656 {
3657     return m_client.blockedByContentBlockerError(request);
3658 }
3659
3660 ResourceError FrameLoader::blockedError(const ResourceRequest& request) const
3661 {
3662     ResourceError error = m_client.blockedError(request);
3663     error.setType(ResourceError::Type::Cancellation);
3664     return error;
3665 }
3666
3667 #if ENABLE(CONTENT_FILTERING)
3668 ResourceError FrameLoader::blockedByContentFilterError(const ResourceRequest& request) const
3669 {
3670     ResourceError error = m_client.blockedByContentFilterError(request);
3671     error.setType(ResourceError::Type::General);
3672     return error;
3673 }
3674 #endif
3675
3676 #if PLATFORM(IOS)
3677 RetainPtr<CFDictionaryRef> FrameLoader::connectionProperties(ResourceLoader* loader)
3678 {
3679     return m_client.connectionProperties(loader->documentLoader(), loader->identifier());
3680 }
3681 #endif
3682
3683 ReferrerPolicy FrameLoader::effectiveReferrerPolicy() const
3684 {
3685     if (auto* parentFrame = m_frame.tree().parent())
3686         return parentFrame->document()->referrerPolicy();
3687     if (m_opener)
3688         return m_opener->document()->referrerPolicy();
3689     return ReferrerPolicy::NoReferrerWhenDowngrade;
3690 }
3691
3692 String FrameLoader::referrer() const
3693 {
3694     return m_documentLoader ? m_documentLoader->request().httpReferrer() : emptyString();
3695 }
3696
3697 void FrameLoader::dispatchDidClearWindowObjectsInAllWorlds()
3698 {
3699     if (!m_frame.script().canExecuteScripts(NotAboutToExecuteScript))
3700         return;
3701
3702     Vector<Ref<DOMWrapperWorld>> worlds;
3703     ScriptController::getAllWorlds(worlds);
3704     for (auto& world : worlds)
3705         dispatchDidClearWindowObjectInWorld(world);
3706 }
3707
3708 void FrameLoader::dispatchDidClearWindowObjectInWorld(DOMWrapperWorld& world)
3709 {
3710     if (!m_frame.script().canExecuteScripts(NotAboutToExecuteScript) || !m_frame.windowProxy().existingJSWindowProxy(world))
3711         return;
3712
3713     m_client.dispatchDidClearWindowObjectInWorld(world);
3714
3715     if (Page* page = m_frame.page())
3716         page->inspectorController().didClearWindowObjectInWorld(m_frame, world);
3717
3718     InspectorInstrumentation::didClearWindowObjectInWorld(m_frame, world);
3719 }
3720
3721 void FrameLoader::dispatchGlobalObjectAvailableInAllWorlds()
3722 {
3723     Vector<Ref<DOMWrapperWorld>> worlds;
3724     ScriptController::getAllWorlds(worlds);
3725     for (auto& world : worlds)
3726         m_client.dispatchGlobalObjectAvailable(world);
3727 }
3728
3729 SandboxFlags FrameLoader::effectiveSandboxFlags() const
3730 {
3731     SandboxFlags flags = m_forcedSandboxFlags;
3732     if (Frame* parentFrame = m_frame.tree().parent())
3733         flags |= parentFrame->document()->sandboxFlags();
3734     if (HTMLFrameOwnerElement* ownerElement = m_frame.ownerElement())
3735         flags |= ownerElement->sandboxFlags();
3736     return flags;
3737 }
3738
3739 void FrameLoader::didChangeTitle(DocumentLoader* loader)
3740 {
3741     m_client.didChangeTitle(loader);
3742
3743     if (loader == m_documentLoader) {
3744         // Must update the entries in the back-forward list too.
3745         history().setCurrentItemTitle(loader->title());
3746         // This must go through the WebFrame because it has the right notion of the current b/f item.
3747         m_client.setTitle(loader->title(), loader->urlForHistory());
3748         m_client.setMainFrameDocumentReady(true); // update observers with new DOMDocument
3749         m_client.dispatchDidReceiveTitle(loader->title());
3750     }
3751
3752 #if ENABLE(REMOTE_INSPECTOR)
3753     if (m_frame.isMainFrame())
3754         m_frame.page()->remoteInspectorInformationDidChange();
3755 #endif
3756 }
3757
3758 void FrameLoader::dispatchDidCommitLoad(std::optional<HasInsecureContent> initialHasInsecureContent)
3759 {
3760     if (m_stateMachine.creatingInitialEmptyDocument())
3761         return;
3762
3763     m_client.dispatchDidCommitLoad(initialHasInsecureContent);
3764
3765     if (m_frame.isMainFrame()) {
3766         m_frame.page()->resetSeenPlugins();
3767         m_frame.page()->resetSeenMediaEngines();
3768     }
3769
3770     InspectorInstrumentation::didCommitLoad(m_frame, m_documentLoader.get());
3771
3772 #if ENABLE(REMOTE_INSPECTOR)
3773     if (m_frame.isMainFrame())
3774         m_frame.page()->remoteInspectorInformationDidChange();
3775 #endif
3776 }
3777
3778 void FrameLoader::tellClientAboutPastMemoryCacheLoads()
3779 {
3780     ASSERT(m_frame.page());
3781     ASSERT(m_frame.page()->areMemoryCacheClientCallsEnabled());
3782
3783     if (!m_documentLoader)
3784         return;
3785
3786     Vector<ResourceRequest> pastLoads;
3787     m_documentLoader->takeMemoryCacheLoadsForClientNotification(pastLoads);
3788
3789     for (auto& pastLoad : pastLoads) {
3790         CachedResource* resource = MemoryCache::singleton().resourceForRequest(pastLoad, m_frame.page()->sessionID());
3791
3792         // FIXME: These loads, loaded from cache, but now gone from the cache by the time
3793         // Page::setMemoryCacheClientCallsEnabled(true) is called, will not be seen by the client.
3794         // Consider if there's some efficient way of remembering enough to deliver this client call.
3795         // We have the URL, but not the rest of the response or the length.
3796         if (!resource)
3797             continue;
3798
3799         ResourceRequest request(resource->url());
3800         m_client.dispatchDidLoadResourceFromMemoryCache(m_documentLoader.get(), request, resource->response(), resource->encodedSize());
3801     }
3802 }
3803
3804 NetworkingContext* FrameLoader::networkingContext() const
3805 {
3806     return m_networkingContext.get();
3807 }
3808
3809 void FrameLoader::loadProgressingStatusChanged()
3810 {
3811     if (auto* view = m_frame.mainFrame().view())
3812         view->loadProgressingStatusChanged();
3813 }
3814
3815 void FrameLoader::forcePageTransitionIfNeeded()
3816 {
3817     m_client.forcePageTransitionIfNeeded();
3818 }
3819
3820 void FrameLoader::clearTestingOverrides()
3821 {
3822     m_overrideCachePolicyForTesting = std::nullopt;
3823     m_overrideResourceLoadPriorityForTesting = std::nullopt;
3824     m_isStrictRawResourceValidationPolicyDisabledForTesting = false;
3825 }
3826
3827 bool FrameLoader::isAlwaysOnLoggingAllowed() const
3828 {
3829     return frame().isAlwaysOnLoggingAllowed();
3830 }
3831
3832 bool FrameLoaderClient::hasHTMLView() const
3833 {
3834     return true;
3835 }
3836
3837 RefPtr<Frame> createWindow(Frame& openerFrame, Frame& lookupFrame, FrameLoadRequest&& request, const WindowFeatures& features, bool& created)
3838 {
3839     ASSERT(!features.dialog || request.frameName().isEmpty());
3840
3841     created = false;
3842
3843     // FIXME: Provide line number information with respect to the opener's document.
3844     if (protocolIsJavaScript(request.resourceRequest().url()) && !openerFrame.document()->contentSecurityPolicy()->allowJavaScriptURLs(openerFrame.document()->url(), { }))
3845         return nullptr;
3846
3847     if (!request.frameName().isEmpty() && !equalIgnoringASCIICase(request.frameName(), "_blank")) {
3848         if (RefPtr<Frame> frame = lookupFrame.loader().findFrameForNavigation(request.frameName(), openerFrame.document())) {
3849             if (!equalIgnoringASCIICase(request.frameName(), "_self")) {
3850                 if (Page* page = frame->page())
3851                     page->chrome().focus();
3852             }
3853             return frame;
3854         }
3855     }
3856
3857     // Sandboxed frames cannot open new auxiliary browsing contexts.
3858     if (isDocumentSandboxed(openerFrame, SandboxPopups)) {
3859         // FIXME: This message should be moved off the console once a solution to https://bugs.webkit.org/show_bug.cgi?id=103274 exists.
3860         openerFrame.document()->addConsoleMessage(MessageSource::Security, MessageLevel::Error, "Blocked opening '" + request.resourceRequest().url().stringCenterEllipsizedToLength() + "' in a new window because the request was made in a sandboxed frame whose 'allow-popups' permission is not set.");
3861         return nullptr;
3862     }
3863
3864     // FIXME: Setting the referrer should be the caller's responsibility.
3865     String referrer = SecurityPolicy::generateReferrerHeader(openerFrame.document()->referrerPolicy(), request.resourceRequest().url(), openerFrame.loader().outgoingReferrer());
3866     if (!referrer.isEmpty())
3867         request.resourceRequest().setHTTPReferrer(referrer);
3868     FrameLoader::addHTTPOriginIfNeeded(request.resourceRequest(), openerFrame.loader().outgoingOrigin());
3869     FrameLoader::addHTTPUpgradeInsecureRequestsIfNeeded(request.resourceRequest());
3870     FrameLoader::addSameSiteInfoToRequestIfNeeded(request.resourceRequest(), openerFrame.document());
3871
3872     Page* oldPage = openerFrame.page();
3873     if (!oldPage)
3874         return nullptr;
3875
3876     ShouldOpenExternalURLsPolicy shouldOpenExternalURLsPolicy = shouldOpenExternalURLsPolicyToApply(openerFrame, request);
3877     NavigationAction action { request.requester(), request.resourceRequest(), request.initiatedByMainFrame(), NavigationType::Other, shouldOpenExternalURLsPolicy };
3878     Page* page = oldPage->chrome().createWindow(openerFrame, request, features, action);
3879     if (!page)
3880         return nullptr;
3881
3882     RefPtr<Frame> frame = &page->mainFrame();
3883
3884     if (isDocumentSandboxed(openerFrame, SandboxPropagatesToAuxiliaryBrowsingContexts))
3885         frame->loader().forceSandboxFlags(openerFrame.document()->sandboxFlags());
3886
3887     if (!equalIgnoringASCIICase(request.frameName(), "_blank"))
3888         frame->tree().setName(request.frameName());
3889
3890     page->chrome().setToolbarsVisible(features.toolBarVisible || features.locationBarVisible);
3891
3892     if (!frame->page())
3893         return nullptr;
3894     page->chrome().setStatusbarVisible(features.statusBarVisible);
3895
3896     if (!frame->page())
3897         return nullptr;
3898     page->chrome().setScrollbarsVisible(features.scrollbarsVisible);
3899
3900     if (!frame->page())
3901         return nullptr;
3902     page->chrome().setMenubarVisible(features.menuBarVisible);
3903
3904     if (!frame->page())
3905         return nullptr;
3906     page->chrome().setResizable(features.resizable);
3907
3908     // 'x' and 'y' specify the location of the window, while 'width' and 'height'
3909     // specify the size of the viewport. We can only resize the window, so adjust
3910     // for the difference between the window size and the viewport size.
3911
3912     // FIXME: We should reconcile the initialization of viewport arguments between iOS and non-IOS.
3913 #if !PLATFORM(IOS)
3914     FloatSize viewportSize = page->chrome().pageRect().size();
3915     FloatRect windowRect = page->chrome().windowRect();
3916     if (features.x)
3917         windowRect.setX(*features.x);
3918     if (features.y)
3919         windowRect.setY(*features.y);
3920     // Zero width and height mean using default size, not minumum one.
3921     if (features.width && *features.width)
3922         windowRect.setWidth(*features.width + (windowRect.width() - viewportSize.width()));
3923     if (features.height && *features.height)
3924         windowRect.setHeight(*features.height + (windowRect.height() - viewportSize.height()));
3925
3926     // Ensure non-NaN values, minimum size as well as being within valid screen area.
3927     FloatRect newWindowRect = DOMWindow::adjustWindowRect(*page, windowRect);
3928
3929     if (!frame->page())
3930         return nullptr;
3931     page->chrome().setWindowRect(newWindowRect);
3932 #else
3933     // On iOS, width and height refer to the viewport dimensions.
3934     ViewportArguments arguments;
3935     // Zero width and height mean using default size, not minimum one.
3936     if (features.width && *features.width)
3937         arguments.width = *features.width;
3938     if (features.height && *features.height)
3939         arguments.height = *features.height;
3940     frame->setViewportArguments(arguments);
3941 #endif
3942
3943     if (!frame->page())
3944         return nullptr;
3945     page->chrome().show();
3946
3947     created = true;
3948     return frame;
3949 }
3950
3951 bool FrameLoader::shouldSuppressTextInputFromEditing() const
3952 {
3953     return m_frame.settings().shouldSuppressTextInputFromEditingDuringProvisionalNavigation() && m_state == FrameStateProvisional;
3954 }
3955
3956 } // namespace WebCore