NavigationScheduler.cpp [plain text]
#include "config.h"
#include "NavigationScheduler.h"
#include "BackForwardController.h"
#include "CommonVM.h"
#include "DOMWindow.h"
#include "DocumentLoader.h"
#include "Event.h"
#include "FormState.h"
#include "FormSubmission.h"
#include "Frame.h"
#include "FrameLoadRequest.h"
#include "FrameLoader.h"
#include "FrameLoaderStateMachine.h"
#include "HTMLFormElement.h"
#include "HTMLFrameOwnerElement.h"
#include "HistoryItem.h"
#include "InspectorInstrumentation.h"
#include "Logging.h"
#include "NavigationDisabler.h"
#include "Page.h"
#include "PolicyChecker.h"
#include "ScriptController.h"
#include "UserGestureIndicator.h"
#include <wtf/Ref.h>
namespace WebCore {
unsigned NavigationDisabler::s_globalNavigationDisableCount = 0;
class ScheduledNavigation {
WTF_MAKE_NONCOPYABLE(ScheduledNavigation); WTF_MAKE_FAST_ALLOCATED;
public:
ScheduledNavigation(double delay, LockHistory lockHistory, LockBackForwardList lockBackForwardList, bool wasDuringLoad, bool isLocationChange)
: m_delay(delay)
, m_lockHistory(lockHistory)
, m_lockBackForwardList(lockBackForwardList)
, m_wasDuringLoad(wasDuringLoad)
, m_isLocationChange(isLocationChange)
, m_userGestureToForward(UserGestureIndicator::currentUserGesture())
{
}
ScheduledNavigation(double delay, LockHistory lockHistory, LockBackForwardList lockBackForwardList, bool wasDuringLoad, bool isLocationChange, ShouldOpenExternalURLsPolicy externalURLPolicy)
: m_delay(delay)
, m_lockHistory(lockHistory)
, m_lockBackForwardList(lockBackForwardList)
, m_wasDuringLoad(wasDuringLoad)
, m_isLocationChange(isLocationChange)
, m_userGestureToForward(UserGestureIndicator::currentUserGesture())
, m_shouldOpenExternalURLsPolicy(externalURLPolicy)
{
if (auto* frame = lexicalFrameFromCommonVM()) {
if (frame->isMainFrame())
m_initiatedByMainFrame = InitiatedByMainFrame::Yes;
}
}
virtual ~ScheduledNavigation() = default;
virtual void fire(Frame&) = 0;
virtual bool shouldStartTimer(Frame&) { return true; }
virtual void didStartTimer(Frame&, Timer&) { }
virtual void didStopTimer(Frame&, NewLoadInProgress) { }
double delay() const { return m_delay; }
LockHistory lockHistory() const { return m_lockHistory; }
LockBackForwardList lockBackForwardList() const { return m_lockBackForwardList; }
bool wasDuringLoad() const { return m_wasDuringLoad; }
bool isLocationChange() const { return m_isLocationChange; }
UserGestureToken* userGestureToForward() const { return m_userGestureToForward.get(); }
protected:
void clearUserGesture() { m_userGestureToForward = nullptr; }
ShouldOpenExternalURLsPolicy shouldOpenExternalURLs() const { return m_shouldOpenExternalURLsPolicy; }
InitiatedByMainFrame initiatedByMainFrame() const { return m_initiatedByMainFrame; };
private:
double m_delay;
LockHistory m_lockHistory;
LockBackForwardList m_lockBackForwardList;
bool m_wasDuringLoad;
bool m_isLocationChange;
RefPtr<UserGestureToken> m_userGestureToForward;
ShouldOpenExternalURLsPolicy m_shouldOpenExternalURLsPolicy { ShouldOpenExternalURLsPolicy::ShouldNotAllow };
InitiatedByMainFrame m_initiatedByMainFrame { InitiatedByMainFrame::Unknown };
};
class ScheduledURLNavigation : public ScheduledNavigation {
protected:
ScheduledURLNavigation(Document& initiatingDocument, double delay, SecurityOrigin* securityOrigin, const URL& url, const String& referrer, LockHistory lockHistory, LockBackForwardList lockBackForwardList, bool duringLoad, bool isLocationChange)
: ScheduledNavigation(delay, lockHistory, lockBackForwardList, duringLoad, isLocationChange, initiatingDocument.shouldOpenExternalURLsPolicyToPropagate())
, m_initiatingDocument { makeRef(initiatingDocument) }
, m_securityOrigin{ makeRefPtr(securityOrigin) }
, m_url { url }
, m_referrer { referrer }
{
}
void didStartTimer(Frame& frame, Timer& timer) override
{
if (m_haveToldClient)
return;
m_haveToldClient = true;
UserGestureIndicator gestureIndicator(userGestureToForward());
frame.loader().clientRedirected(m_url, delay(), WallTime::now() + timer.nextFireInterval(), lockBackForwardList());
}
void didStopTimer(Frame& frame, NewLoadInProgress newLoadInProgress) override
{
if (!m_haveToldClient)
return;
frame.loader().clientRedirectCancelledOrFinished(newLoadInProgress);
}
Document& initiatingDocument() { return m_initiatingDocument.get(); }
SecurityOrigin* securityOrigin() const { return m_securityOrigin.get(); }
const URL& url() const { return m_url; }
String referrer() const { return m_referrer; }
private:
Ref<Document> m_initiatingDocument;
RefPtr<SecurityOrigin> m_securityOrigin;
URL m_url;
String m_referrer;
bool m_haveToldClient { false };
};
class ScheduledRedirect : public ScheduledURLNavigation {
public:
ScheduledRedirect(Document& initiatingDocument, double delay, SecurityOrigin* securityOrigin, const URL& url, LockHistory lockHistory, LockBackForwardList lockBackForwardList)
: ScheduledURLNavigation(initiatingDocument, delay, securityOrigin, url, String(), lockHistory, lockBackForwardList, false, false)
{
clearUserGesture();
}
bool shouldStartTimer(Frame& frame) override
{
return frame.loader().allAncestorsAreComplete();
}
void fire(Frame& frame) override
{
UserGestureIndicator gestureIndicator { userGestureToForward() };
bool refresh = equalIgnoringFragmentIdentifier(frame.document()->url(), url());
ResourceRequest resourceRequest { url(), referrer(), refresh ? ResourceRequestCachePolicy::ReloadIgnoringCacheData : ResourceRequestCachePolicy::UseProtocolCachePolicy };
if (initiatedByMainFrame() == InitiatedByMainFrame::Yes)
resourceRequest.setRequester(ResourceRequest::Requester::Main);
FrameLoadRequest frameLoadRequest { initiatingDocument(), *securityOrigin(), resourceRequest, "_self", lockHistory(), lockBackForwardList(), MaybeSendReferrer, AllowNavigationToInvalidURL::No, NewFrameOpenerPolicy::Allow, shouldOpenExternalURLs(), initiatedByMainFrame() };
frame.loader().changeLocation(WTFMove(frameLoadRequest));
}
};
class ScheduledLocationChange : public ScheduledURLNavigation {
public:
ScheduledLocationChange(Document& initiatingDocument, SecurityOrigin* securityOrigin, const URL& url, const String& referrer, LockHistory lockHistory, LockBackForwardList lockBackForwardList, bool duringLoad)
: ScheduledURLNavigation(initiatingDocument, 0.0, securityOrigin, url, referrer, lockHistory, lockBackForwardList, duringLoad, true) { }
void fire(Frame& frame) override
{
UserGestureIndicator gestureIndicator { userGestureToForward() };
ResourceRequest resourceRequest { url(), referrer(), ResourceRequestCachePolicy::UseProtocolCachePolicy };
FrameLoadRequest frameLoadRequest { initiatingDocument(), *securityOrigin(), resourceRequest, "_self", lockHistory(), lockBackForwardList(), MaybeSendReferrer, AllowNavigationToInvalidURL::No, NewFrameOpenerPolicy::Allow, shouldOpenExternalURLs(), initiatedByMainFrame() };
frame.loader().changeLocation(WTFMove(frameLoadRequest));
}
};
class ScheduledRefresh : public ScheduledURLNavigation {
public:
ScheduledRefresh(Document& initiatingDocument, SecurityOrigin* securityOrigin, const URL& url, const String& referrer)
: ScheduledURLNavigation(initiatingDocument, 0.0, securityOrigin, url, referrer, LockHistory::Yes, LockBackForwardList::Yes, false, true)
{
}
void fire(Frame& frame) override
{
UserGestureIndicator gestureIndicator { userGestureToForward() };
ResourceRequest resourceRequest { url(), referrer(), ResourceRequestCachePolicy::ReloadIgnoringCacheData };
FrameLoadRequest frameLoadRequest { initiatingDocument(), *securityOrigin(), resourceRequest, "_self", lockHistory(), lockBackForwardList(), MaybeSendReferrer, AllowNavigationToInvalidURL::Yes, NewFrameOpenerPolicy::Allow, shouldOpenExternalURLs(), initiatedByMainFrame() };
frame.loader().changeLocation(WTFMove(frameLoadRequest));
}
};
class ScheduledHistoryNavigation : public ScheduledNavigation {
public:
explicit ScheduledHistoryNavigation(int historySteps)
: ScheduledNavigation(0, LockHistory::No, LockBackForwardList::No, false, true)
, m_historySteps(historySteps)
{
}
void fire(Frame& frame) override
{
UserGestureIndicator gestureIndicator(userGestureToForward());
if (!m_historySteps) {
frame.loader().urlSelected(frame.document()->url(), "_self", 0, lockHistory(), lockBackForwardList(), MaybeSendReferrer, shouldOpenExternalURLs());
return;
}
frame.page()->backForward().goBackOrForward(m_historySteps);
}
private:
int m_historySteps;
};
class ScheduledFormSubmission : public ScheduledNavigation {
public:
ScheduledFormSubmission(Ref<FormSubmission>&& submission, LockBackForwardList lockBackForwardList, bool duringLoad)
: ScheduledNavigation(0, submission->lockHistory(), lockBackForwardList, duringLoad, true, submission->state().sourceDocument().shouldOpenExternalURLsPolicyToPropagate())
, m_submission(WTFMove(submission))
{
}
void fire(Frame& frame) override
{
UserGestureIndicator gestureIndicator(userGestureToForward());
auto& requestingDocument = m_submission->state().sourceDocument();
if (!requestingDocument.canNavigate(&frame))
return;
FrameLoadRequest frameLoadRequest { requestingDocument, requestingDocument.securityOrigin(), { }, { }, lockHistory(), lockBackForwardList(), MaybeSendReferrer, AllowNavigationToInvalidURL::Yes, NewFrameOpenerPolicy::Allow, shouldOpenExternalURLs(), initiatedByMainFrame() };
m_submission->populateFrameLoadRequest(frameLoadRequest);
frame.loader().loadFrameRequest(WTFMove(frameLoadRequest), m_submission->event(), m_submission->takeState());
}
void didStartTimer(Frame& frame, Timer& timer) override
{
if (m_haveToldClient)
return;
m_haveToldClient = true;
UserGestureIndicator gestureIndicator(userGestureToForward());
frame.loader().clientRedirected(m_submission->requestURL(), delay(), WallTime::now() + timer.nextFireInterval(), lockBackForwardList());
}
void didStopTimer(Frame& frame, NewLoadInProgress newLoadInProgress) override
{
if (!m_haveToldClient)
return;
frame.loader().clientRedirectCancelledOrFinished(newLoadInProgress);
}
private:
Ref<FormSubmission> m_submission;
bool m_haveToldClient { false };
};
class ScheduledPageBlock final : public ScheduledNavigation {
public:
ScheduledPageBlock(Document& originDocument)
: ScheduledNavigation(0, LockHistory::Yes, LockBackForwardList::Yes, false, false)
, m_originDocument(originDocument)
{
}
void fire(Frame& frame) override
{
UserGestureIndicator gestureIndicator { userGestureToForward() };
ResourceResponse replacementResponse { m_originDocument.url(), "text/plain"_s, 0, "UTF-8"_s };
SubstituteData replacementData { SharedBuffer::create(), m_originDocument.url(), replacementResponse, SubstituteData::SessionHistoryVisibility::Hidden };
ResourceRequest resourceRequest { m_originDocument.url(), emptyString(), ResourceRequestCachePolicy::ReloadIgnoringCacheData };
FrameLoadRequest frameLoadRequest { m_originDocument, m_originDocument.securityOrigin(), resourceRequest, { }, lockHistory(), lockBackForwardList(), MaybeSendReferrer, AllowNavigationToInvalidURL::Yes, NewFrameOpenerPolicy::Allow, shouldOpenExternalURLs(), initiatedByMainFrame() };
frameLoadRequest.setSubstituteData(replacementData);
frame.loader().load(WTFMove(frameLoadRequest));
}
private:
Document& m_originDocument;
};
NavigationScheduler::NavigationScheduler(Frame& frame)
: m_frame(frame)
, m_timer(*this, &NavigationScheduler::timerFired)
{
}
NavigationScheduler::~NavigationScheduler() = default;
bool NavigationScheduler::redirectScheduledDuringLoad()
{
return m_redirect && m_redirect->wasDuringLoad();
}
bool NavigationScheduler::locationChangePending()
{
return m_redirect && m_redirect->isLocationChange();
}
void NavigationScheduler::clear()
{
if (m_timer.isActive())
InspectorInstrumentation::frameClearedScheduledNavigation(m_frame);
m_timer.stop();
m_redirect = nullptr;
}
inline bool NavigationScheduler::shouldScheduleNavigation() const
{
return m_frame.page();
}
inline bool NavigationScheduler::shouldScheduleNavigation(const URL& url) const
{
if (!shouldScheduleNavigation())
return false;
if (WTF::protocolIsJavaScript(url))
return true;
return NavigationDisabler::isNavigationAllowed(m_frame);
}
void NavigationScheduler::scheduleRedirect(Document& initiatingDocument, double delay, const URL& url)
{
if (!shouldScheduleNavigation(url))
return;
if (delay < 0 || delay > INT_MAX / 1000)
return;
if (url.isEmpty())
return;
if (!m_redirect || delay <= m_redirect->delay()) {
auto lockBackForwardList = delay <= 1 ? LockBackForwardList::Yes : LockBackForwardList::No;
schedule(std::make_unique<ScheduledRedirect>(initiatingDocument, delay, &m_frame.document()->securityOrigin(), url, LockHistory::Yes, lockBackForwardList));
}
}
LockBackForwardList NavigationScheduler::mustLockBackForwardList(Frame& targetFrame)
{
if (!UserGestureIndicator::processingUserGesture() && targetFrame.loader().documentLoader() && !targetFrame.loader().documentLoader()->wasOnloadDispatched())
return LockBackForwardList::Yes;
for (Frame* ancestor = targetFrame.tree().parent(); ancestor; ancestor = ancestor->tree().parent()) {
Document* document = ancestor->document();
if (!ancestor->loader().isComplete() || (document && document->processingLoadEvent()))
return LockBackForwardList::Yes;
}
return LockBackForwardList::No;
}
void NavigationScheduler::scheduleLocationChange(Document& initiatingDocument, SecurityOrigin& securityOrigin, const URL& url, const String& referrer, LockHistory lockHistory, LockBackForwardList lockBackForwardList)
{
if (!shouldScheduleNavigation(url))
return;
if (lockBackForwardList == LockBackForwardList::No)
lockBackForwardList = mustLockBackForwardList(m_frame);
FrameLoader& loader = m_frame.loader();
if (url.hasFragmentIdentifier() && equalIgnoringFragmentIdentifier(m_frame.document()->url(), url)) {
ResourceRequest resourceRequest { m_frame.document()->completeURL(url), referrer, ResourceRequestCachePolicy::UseProtocolCachePolicy };
auto* frame = lexicalFrameFromCommonVM();
auto initiatedByMainFrame = frame && frame->isMainFrame() ? InitiatedByMainFrame::Yes : InitiatedByMainFrame::Unknown;
FrameLoadRequest frameLoadRequest { initiatingDocument, securityOrigin, resourceRequest, "_self"_s, lockHistory, lockBackForwardList, MaybeSendReferrer, AllowNavigationToInvalidURL::No, NewFrameOpenerPolicy::Allow, initiatingDocument.shouldOpenExternalURLsPolicyToPropagate(), initiatedByMainFrame };
loader.changeLocation(WTFMove(frameLoadRequest));
return;
}
bool duringLoad = !loader.stateMachine().committedFirstRealDocumentLoad();
schedule(std::make_unique<ScheduledLocationChange>(initiatingDocument, &securityOrigin, url, referrer, lockHistory, lockBackForwardList, duringLoad));
}
void NavigationScheduler::scheduleFormSubmission(Ref<FormSubmission>&& submission)
{
ASSERT(m_frame.page());
bool duringLoad = !m_frame.loader().stateMachine().committedFirstRealDocumentLoad();
LockBackForwardList lockBackForwardList = mustLockBackForwardList(m_frame);
if (lockBackForwardList == LockBackForwardList::No
&& (submission->state().formSubmissionTrigger() == SubmittedByJavaScript && m_frame.tree().parent() && !UserGestureIndicator::processingUserGesture())) {
lockBackForwardList = LockBackForwardList::Yes;
}
schedule(std::make_unique<ScheduledFormSubmission>(WTFMove(submission), lockBackForwardList, duringLoad));
}
void NavigationScheduler::scheduleRefresh(Document& initiatingDocument)
{
if (!shouldScheduleNavigation())
return;
const URL& url = m_frame.document()->url();
if (url.isEmpty())
return;
schedule(std::make_unique<ScheduledRefresh>(initiatingDocument, &m_frame.document()->securityOrigin(), url, m_frame.loader().outgoingReferrer()));
}
void NavigationScheduler::scheduleHistoryNavigation(int steps)
{
LOG(History, "NavigationScheduler %p scheduleHistoryNavigation(%d) - shouldSchedule %d", this, steps, shouldScheduleNavigation());
if (!shouldScheduleNavigation())
return;
BackForwardController& backForward = m_frame.page()->backForward();
if ((steps > 0 && static_cast<unsigned>(steps) > backForward.forwardCount())
|| (steps < 0 && static_cast<unsigned>(-steps) > backForward.backCount())) {
cancel();
return;
}
schedule(std::make_unique<ScheduledHistoryNavigation>(steps));
}
void NavigationScheduler::schedulePageBlock(Document& originDocument)
{
if (shouldScheduleNavigation())
schedule(std::make_unique<ScheduledPageBlock>(originDocument));
}
void NavigationScheduler::timerFired()
{
if (!m_frame.page())
return;
if (m_frame.page()->defersLoading()) {
InspectorInstrumentation::frameClearedScheduledNavigation(m_frame);
return;
}
Ref<Frame> protect(m_frame);
std::unique_ptr<ScheduledNavigation> redirect = WTFMove(m_redirect);
LOG(History, "NavigationScheduler %p timerFired - firing redirect %p", this, redirect.get());
redirect->fire(m_frame);
InspectorInstrumentation::frameClearedScheduledNavigation(m_frame);
}
void NavigationScheduler::schedule(std::unique_ptr<ScheduledNavigation> redirect)
{
ASSERT(m_frame.page());
Ref<Frame> protect(m_frame);
if (redirect->wasDuringLoad()) {
if (DocumentLoader* provisionalDocumentLoader = m_frame.loader().provisionalDocumentLoader())
provisionalDocumentLoader->stopLoading();
m_frame.loader().stopLoading(UnloadEventPolicyUnloadAndPageHide);
}
cancel();
m_redirect = WTFMove(redirect);
if (!m_frame.loader().isComplete() && m_redirect->isLocationChange())
m_frame.loader().completed();
if (!m_frame.page())
return;
startTimer();
}
void NavigationScheduler::startTimer()
{
if (!m_redirect)
return;
ASSERT(m_frame.page());
if (m_timer.isActive())
return;
if (!m_redirect->shouldStartTimer(m_frame))
return;
Seconds delay = 1_s * m_redirect->delay();
m_timer.startOneShot(delay);
InspectorInstrumentation::frameScheduledNavigation(m_frame, delay);
m_redirect->didStartTimer(m_frame, m_timer); }
void NavigationScheduler::cancel(NewLoadInProgress newLoadInProgress)
{
LOG(History, "NavigationScheduler %p cancel(newLoadInProgress=%d)", this, newLoadInProgress == NewLoadInProgress::Yes);
if (m_timer.isActive())
InspectorInstrumentation::frameClearedScheduledNavigation(m_frame);
m_timer.stop();
if (auto redirect = WTFMove(m_redirect))
redirect->didStopTimer(m_frame, newLoadInProgress);
}
}