Move URL from WebCore to WTF
[WebKit-https.git] / Source / WebCore / loader / NavigationScheduler.cpp
1 /*
2  * Copyright (C) 2006-2017 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) 2009 Adam Barth. All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * 1.  Redistributions of source code must retain the above copyright
12  *     notice, this list of conditions and the following disclaimer. 
13  * 2.  Redistributions in binary form must reproduce the above copyright
14  *     notice, this list of conditions and the following disclaimer in the
15  *     documentation and/or other materials provided with the distribution. 
16  * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
17  *     its contributors may be used to endorse or promote products derived
18  *     from this software without specific prior written permission. 
19  *
20  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
21  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
22  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
23  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
24  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
25  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
26  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
27  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
29  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  */
31
32 #include "config.h"
33 #include "NavigationScheduler.h"
34
35 #include "BackForwardController.h"
36 #include "CommonVM.h"
37 #include "DOMWindow.h"
38 #include "DocumentLoader.h"
39 #include "Event.h"
40 #include "FormState.h"
41 #include "FormSubmission.h"
42 #include "Frame.h"
43 #include "FrameLoadRequest.h"
44 #include "FrameLoader.h"
45 #include "FrameLoaderStateMachine.h"
46 #include "HTMLFormElement.h"
47 #include "HTMLFrameOwnerElement.h"
48 #include "HistoryItem.h"
49 #include "InspectorInstrumentation.h"
50 #include "Logging.h"
51 #include "NavigationDisabler.h"
52 #include "Page.h"
53 #include "PolicyChecker.h"
54 #include "ScriptController.h"
55 #include "UserGestureIndicator.h"
56 #include <wtf/Ref.h>
57
58 namespace WebCore {
59
60 unsigned NavigationDisabler::s_globalNavigationDisableCount = 0;
61
62 class ScheduledNavigation {
63     WTF_MAKE_NONCOPYABLE(ScheduledNavigation); WTF_MAKE_FAST_ALLOCATED;
64 public:
65     ScheduledNavigation(double delay, LockHistory lockHistory, LockBackForwardList lockBackForwardList, bool wasDuringLoad, bool isLocationChange)
66         : m_delay(delay)
67         , m_lockHistory(lockHistory)
68         , m_lockBackForwardList(lockBackForwardList)
69         , m_wasDuringLoad(wasDuringLoad)
70         , m_isLocationChange(isLocationChange)
71         , m_userGestureToForward(UserGestureIndicator::currentUserGesture())
72     {
73     }
74     ScheduledNavigation(double delay, LockHistory lockHistory, LockBackForwardList lockBackForwardList, bool wasDuringLoad, bool isLocationChange, ShouldOpenExternalURLsPolicy externalURLPolicy)
75         : m_delay(delay)
76         , m_lockHistory(lockHistory)
77         , m_lockBackForwardList(lockBackForwardList)
78         , m_wasDuringLoad(wasDuringLoad)
79         , m_isLocationChange(isLocationChange)
80         , m_userGestureToForward(UserGestureIndicator::currentUserGesture())
81         , m_shouldOpenExternalURLsPolicy(externalURLPolicy)
82     {
83         if (auto* frame = lexicalFrameFromCommonVM()) {
84             if (frame->isMainFrame())
85                 m_initiatedByMainFrame = InitiatedByMainFrame::Yes;
86         }
87     }
88     virtual ~ScheduledNavigation() = default;
89
90     virtual void fire(Frame&) = 0;
91
92     virtual bool shouldStartTimer(Frame&) { return true; }
93     virtual void didStartTimer(Frame&, Timer&) { }
94     virtual void didStopTimer(Frame&, NewLoadInProgress) { }
95
96     double delay() const { return m_delay; }
97     LockHistory lockHistory() const { return m_lockHistory; }
98     LockBackForwardList lockBackForwardList() const { return m_lockBackForwardList; }
99     bool wasDuringLoad() const { return m_wasDuringLoad; }
100     bool isLocationChange() const { return m_isLocationChange; }
101     UserGestureToken* userGestureToForward() const { return m_userGestureToForward.get(); }
102
103 protected:
104     void clearUserGesture() { m_userGestureToForward = nullptr; }
105     ShouldOpenExternalURLsPolicy shouldOpenExternalURLs() const { return m_shouldOpenExternalURLsPolicy; }
106     InitiatedByMainFrame initiatedByMainFrame() const { return m_initiatedByMainFrame; };
107
108 private:
109     double m_delay;
110     LockHistory m_lockHistory;
111     LockBackForwardList m_lockBackForwardList;
112     bool m_wasDuringLoad;
113     bool m_isLocationChange;
114     RefPtr<UserGestureToken> m_userGestureToForward;
115     ShouldOpenExternalURLsPolicy m_shouldOpenExternalURLsPolicy { ShouldOpenExternalURLsPolicy::ShouldNotAllow };
116     InitiatedByMainFrame m_initiatedByMainFrame { InitiatedByMainFrame::Unknown };
117 };
118
119 class ScheduledURLNavigation : public ScheduledNavigation {
120 protected:
121     ScheduledURLNavigation(Document& initiatingDocument, double delay, SecurityOrigin* securityOrigin, const URL& url, const String& referrer, LockHistory lockHistory, LockBackForwardList lockBackForwardList, bool duringLoad, bool isLocationChange)
122         : ScheduledNavigation(delay, lockHistory, lockBackForwardList, duringLoad, isLocationChange, initiatingDocument.shouldOpenExternalURLsPolicyToPropagate())
123         , m_initiatingDocument { makeRef(initiatingDocument) }
124         , m_securityOrigin{ makeRefPtr(securityOrigin) }
125         , m_url { url }
126         , m_referrer { referrer }
127     {
128     }
129
130     void didStartTimer(Frame& frame, Timer& timer) override
131     {
132         if (m_haveToldClient)
133             return;
134         m_haveToldClient = true;
135
136         UserGestureIndicator gestureIndicator(userGestureToForward());
137         frame.loader().clientRedirected(m_url, delay(), WallTime::now() + timer.nextFireInterval(), lockBackForwardList());
138     }
139
140     void didStopTimer(Frame& frame, NewLoadInProgress newLoadInProgress) override
141     {
142         if (!m_haveToldClient)
143             return;
144
145         // Do not set a UserGestureIndicator because
146         // clientRedirectCancelledOrFinished() is also called from many places
147         // inside FrameLoader, where the gesture state is not set and is in
148         // fact unavailable. We need to be consistent with them, otherwise the
149         // gesture state will sometimes be set and sometimes not within
150         // dispatchDidCancelClientRedirect().
151         frame.loader().clientRedirectCancelledOrFinished(newLoadInProgress);
152     }
153
154     Document& initiatingDocument() { return m_initiatingDocument.get(); }
155     SecurityOrigin* securityOrigin() const { return m_securityOrigin.get(); }
156     const URL& url() const { return m_url; }
157     String referrer() const { return m_referrer; }
158
159 private:
160     Ref<Document> m_initiatingDocument;
161     RefPtr<SecurityOrigin> m_securityOrigin;
162     URL m_url;
163     String m_referrer;
164     bool m_haveToldClient { false };
165 };
166
167 class ScheduledRedirect : public ScheduledURLNavigation {
168 public:
169     ScheduledRedirect(Document& initiatingDocument, double delay, SecurityOrigin* securityOrigin, const URL& url, LockHistory lockHistory, LockBackForwardList lockBackForwardList)
170         : ScheduledURLNavigation(initiatingDocument, delay, securityOrigin, url, String(), lockHistory, lockBackForwardList, false, false)
171     {
172         clearUserGesture();
173     }
174
175     bool shouldStartTimer(Frame& frame) override
176     {
177         return frame.loader().allAncestorsAreComplete();
178     }
179
180     void fire(Frame& frame) override
181     {
182         UserGestureIndicator gestureIndicator { userGestureToForward() };
183
184         bool refresh = equalIgnoringFragmentIdentifier(frame.document()->url(), url());
185         ResourceRequest resourceRequest { url(), referrer(), refresh ? ResourceRequestCachePolicy::ReloadIgnoringCacheData : ResourceRequestCachePolicy::UseProtocolCachePolicy };
186         if (initiatedByMainFrame() == InitiatedByMainFrame::Yes)
187             resourceRequest.setRequester(ResourceRequest::Requester::Main);
188         FrameLoadRequest frameLoadRequest { initiatingDocument(), *securityOrigin(), resourceRequest, "_self", lockHistory(), lockBackForwardList(), MaybeSendReferrer, AllowNavigationToInvalidURL::No, NewFrameOpenerPolicy::Allow, shouldOpenExternalURLs(), initiatedByMainFrame() };
189
190         frame.loader().changeLocation(WTFMove(frameLoadRequest));
191     }
192 };
193
194 class ScheduledLocationChange : public ScheduledURLNavigation {
195 public:
196     ScheduledLocationChange(Document& initiatingDocument, SecurityOrigin* securityOrigin, const URL& url, const String& referrer, LockHistory lockHistory, LockBackForwardList lockBackForwardList, bool duringLoad)
197         : ScheduledURLNavigation(initiatingDocument, 0.0, securityOrigin, url, referrer, lockHistory, lockBackForwardList, duringLoad, true) { }
198
199     void fire(Frame& frame) override
200     {
201         UserGestureIndicator gestureIndicator { userGestureToForward() };
202
203         ResourceRequest resourceRequest { url(), referrer(), ResourceRequestCachePolicy::UseProtocolCachePolicy };
204         FrameLoadRequest frameLoadRequest { initiatingDocument(), *securityOrigin(), resourceRequest, "_self", lockHistory(), lockBackForwardList(), MaybeSendReferrer, AllowNavigationToInvalidURL::No, NewFrameOpenerPolicy::Allow, shouldOpenExternalURLs(), initiatedByMainFrame() };
205
206         frame.loader().changeLocation(WTFMove(frameLoadRequest));
207     }
208 };
209
210 class ScheduledRefresh : public ScheduledURLNavigation {
211 public:
212     ScheduledRefresh(Document& initiatingDocument, SecurityOrigin* securityOrigin, const URL& url, const String& referrer)
213         : ScheduledURLNavigation(initiatingDocument, 0.0, securityOrigin, url, referrer, LockHistory::Yes, LockBackForwardList::Yes, false, true)
214     {
215     }
216
217     void fire(Frame& frame) override
218     {
219         UserGestureIndicator gestureIndicator { userGestureToForward() };
220
221         ResourceRequest resourceRequest { url(), referrer(), ResourceRequestCachePolicy::ReloadIgnoringCacheData };
222         FrameLoadRequest frameLoadRequest { initiatingDocument(), *securityOrigin(), resourceRequest, "_self", lockHistory(), lockBackForwardList(), MaybeSendReferrer, AllowNavigationToInvalidURL::Yes, NewFrameOpenerPolicy::Allow, shouldOpenExternalURLs(), initiatedByMainFrame() };
223
224         frame.loader().changeLocation(WTFMove(frameLoadRequest));
225     }
226 };
227
228 class ScheduledHistoryNavigation : public ScheduledNavigation {
229 public:
230     explicit ScheduledHistoryNavigation(int historySteps)
231         : ScheduledNavigation(0, LockHistory::No, LockBackForwardList::No, false, true)
232         , m_historySteps(historySteps)
233     {
234     }
235
236     void fire(Frame& frame) override
237     {
238         UserGestureIndicator gestureIndicator(userGestureToForward());
239
240         if (!m_historySteps) {
241             // Special case for go(0) from a frame -> reload only the frame
242             // To follow Firefox and IE's behavior, history reload can only navigate the self frame.
243             frame.loader().urlSelected(frame.document()->url(), "_self", 0, lockHistory(), lockBackForwardList(), MaybeSendReferrer, shouldOpenExternalURLs());
244             return;
245         }
246         
247         // go(i!=0) from a frame navigates into the history of the frame only,
248         // in both IE and NS (but not in Mozilla). We can't easily do that.
249         frame.page()->backForward().goBackOrForward(m_historySteps);
250     }
251
252 private:
253     int m_historySteps;
254 };
255
256 class ScheduledFormSubmission : public ScheduledNavigation {
257 public:
258     ScheduledFormSubmission(Ref<FormSubmission>&& submission, LockBackForwardList lockBackForwardList, bool duringLoad)
259         : ScheduledNavigation(0, submission->lockHistory(), lockBackForwardList, duringLoad, true, submission->state().sourceDocument().shouldOpenExternalURLsPolicyToPropagate())
260         , m_submission(WTFMove(submission))
261     {
262     }
263
264     void fire(Frame& frame) override
265     {
266         UserGestureIndicator gestureIndicator(userGestureToForward());
267
268         // The submitForm function will find a target frame before using the redirection timer.
269         // Now that the timer has fired, we need to repeat the security check which normally is done when
270         // selecting a target, in case conditions have changed. Other code paths avoid this by targeting
271         // without leaving a time window. If we fail the check just silently drop the form submission.
272         auto& requestingDocument = m_submission->state().sourceDocument();
273         if (!requestingDocument.canNavigate(&frame))
274             return;
275         FrameLoadRequest frameLoadRequest { requestingDocument, requestingDocument.securityOrigin(), { }, { }, lockHistory(), lockBackForwardList(), MaybeSendReferrer, AllowNavigationToInvalidURL::Yes, NewFrameOpenerPolicy::Allow, shouldOpenExternalURLs(), initiatedByMainFrame() };
276         m_submission->populateFrameLoadRequest(frameLoadRequest);
277         frame.loader().loadFrameRequest(WTFMove(frameLoadRequest), m_submission->event(), m_submission->takeState());
278     }
279
280     void didStartTimer(Frame& frame, Timer& timer) override
281     {
282         if (m_haveToldClient)
283             return;
284         m_haveToldClient = true;
285
286         UserGestureIndicator gestureIndicator(userGestureToForward());
287         frame.loader().clientRedirected(m_submission->requestURL(), delay(), WallTime::now() + timer.nextFireInterval(), lockBackForwardList());
288     }
289
290     void didStopTimer(Frame& frame, NewLoadInProgress newLoadInProgress) override
291     {
292         if (!m_haveToldClient)
293             return;
294
295         // Do not set a UserGestureIndicator because
296         // clientRedirectCancelledOrFinished() is also called from many places
297         // inside FrameLoader, where the gesture state is not set and is in
298         // fact unavailable. We need to be consistent with them, otherwise the
299         // gesture state will sometimes be set and sometimes not within
300         // dispatchDidCancelClientRedirect().
301         frame.loader().clientRedirectCancelledOrFinished(newLoadInProgress);
302     }
303
304 private:
305     Ref<FormSubmission> m_submission;
306     bool m_haveToldClient { false };
307 };
308
309 class ScheduledPageBlock final : public ScheduledNavigation {
310 public:
311     ScheduledPageBlock(Document& originDocument)
312         : ScheduledNavigation(0, LockHistory::Yes, LockBackForwardList::Yes, false, false)
313         , m_originDocument(originDocument)
314     {
315     }
316
317     void fire(Frame& frame) override
318     {
319         UserGestureIndicator gestureIndicator { userGestureToForward() };
320
321         ResourceResponse replacementResponse { m_originDocument.url(), "text/plain"_s, 0, "UTF-8"_s };
322         SubstituteData replacementData { SharedBuffer::create(), m_originDocument.url(), replacementResponse, SubstituteData::SessionHistoryVisibility::Hidden };
323
324         ResourceRequest resourceRequest { m_originDocument.url(), emptyString(), ResourceRequestCachePolicy::ReloadIgnoringCacheData };
325         FrameLoadRequest frameLoadRequest { m_originDocument, m_originDocument.securityOrigin(), resourceRequest, { }, lockHistory(), lockBackForwardList(), MaybeSendReferrer, AllowNavigationToInvalidURL::Yes, NewFrameOpenerPolicy::Allow, shouldOpenExternalURLs(), initiatedByMainFrame() };
326         frameLoadRequest.setSubstituteData(replacementData);
327         frame.loader().load(WTFMove(frameLoadRequest));
328     }
329
330 private:
331     Document& m_originDocument;
332 };
333
334 NavigationScheduler::NavigationScheduler(Frame& frame)
335     : m_frame(frame)
336     , m_timer(*this, &NavigationScheduler::timerFired)
337 {
338 }
339
340 NavigationScheduler::~NavigationScheduler() = default;
341
342 bool NavigationScheduler::redirectScheduledDuringLoad()
343 {
344     return m_redirect && m_redirect->wasDuringLoad();
345 }
346
347 bool NavigationScheduler::locationChangePending()
348 {
349     return m_redirect && m_redirect->isLocationChange();
350 }
351
352 void NavigationScheduler::clear()
353 {
354     if (m_timer.isActive())
355         InspectorInstrumentation::frameClearedScheduledNavigation(m_frame);
356     m_timer.stop();
357     m_redirect = nullptr;
358 }
359
360 inline bool NavigationScheduler::shouldScheduleNavigation() const
361 {
362     return m_frame.page();
363 }
364
365 inline bool NavigationScheduler::shouldScheduleNavigation(const URL& url) const
366 {
367     if (!shouldScheduleNavigation())
368         return false;
369     if (WTF::protocolIsJavaScript(url))
370         return true;
371     return NavigationDisabler::isNavigationAllowed(m_frame);
372 }
373
374 void NavigationScheduler::scheduleRedirect(Document& initiatingDocument, double delay, const URL& url)
375 {
376     if (!shouldScheduleNavigation(url))
377         return;
378     if (delay < 0 || delay > INT_MAX / 1000)
379         return;
380     if (url.isEmpty())
381         return;
382
383     // We want a new back/forward list item if the refresh timeout is > 1 second.
384     if (!m_redirect || delay <= m_redirect->delay()) {
385         auto lockBackForwardList = delay <= 1 ? LockBackForwardList::Yes : LockBackForwardList::No;
386         schedule(std::make_unique<ScheduledRedirect>(initiatingDocument, delay, &m_frame.document()->securityOrigin(), url, LockHistory::Yes, lockBackForwardList));
387     }
388 }
389
390 LockBackForwardList NavigationScheduler::mustLockBackForwardList(Frame& targetFrame)
391 {
392     // Non-user navigation before the page has finished firing onload should not create a new back/forward item.
393     // See https://webkit.org/b/42861 for the original motivation for this.    
394     if (!UserGestureIndicator::processingUserGesture() && targetFrame.loader().documentLoader() && !targetFrame.loader().documentLoader()->wasOnloadDispatched())
395         return LockBackForwardList::Yes;
396     
397     // Navigation of a subframe during loading of an ancestor frame does not create a new back/forward item.
398     // The definition of "during load" is any time before all handlers for the load event have been run.
399     // See https://bugs.webkit.org/show_bug.cgi?id=14957 for the original motivation for this.
400     for (Frame* ancestor = targetFrame.tree().parent(); ancestor; ancestor = ancestor->tree().parent()) {
401         Document* document = ancestor->document();
402         if (!ancestor->loader().isComplete() || (document && document->processingLoadEvent()))
403             return LockBackForwardList::Yes;
404     }
405     return LockBackForwardList::No;
406 }
407
408 void NavigationScheduler::scheduleLocationChange(Document& initiatingDocument, SecurityOrigin& securityOrigin, const URL& url, const String& referrer, LockHistory lockHistory, LockBackForwardList lockBackForwardList)
409 {
410     if (!shouldScheduleNavigation(url))
411         return;
412
413     if (lockBackForwardList == LockBackForwardList::No)
414         lockBackForwardList = mustLockBackForwardList(m_frame);
415
416     FrameLoader& loader = m_frame.loader();
417
418     // If the URL we're going to navigate to is the same as the current one, except for the
419     // fragment part, we don't need to schedule the location change.
420     if (url.hasFragmentIdentifier() && equalIgnoringFragmentIdentifier(m_frame.document()->url(), url)) {
421         ResourceRequest resourceRequest { m_frame.document()->completeURL(url), referrer, ResourceRequestCachePolicy::UseProtocolCachePolicy };
422         auto* frame = lexicalFrameFromCommonVM();
423         auto initiatedByMainFrame = frame && frame->isMainFrame() ? InitiatedByMainFrame::Yes : InitiatedByMainFrame::Unknown;
424         
425         FrameLoadRequest frameLoadRequest { initiatingDocument, securityOrigin, resourceRequest, "_self"_s, lockHistory, lockBackForwardList, MaybeSendReferrer, AllowNavigationToInvalidURL::No, NewFrameOpenerPolicy::Allow, initiatingDocument.shouldOpenExternalURLsPolicyToPropagate(), initiatedByMainFrame };
426         loader.changeLocation(WTFMove(frameLoadRequest));
427         return;
428     }
429
430     // Handle a location change of a page with no document as a special case.
431     // This may happen when a frame changes the location of another frame.
432     bool duringLoad = !loader.stateMachine().committedFirstRealDocumentLoad();
433
434     schedule(std::make_unique<ScheduledLocationChange>(initiatingDocument, &securityOrigin, url, referrer, lockHistory, lockBackForwardList, duringLoad));
435 }
436
437 void NavigationScheduler::scheduleFormSubmission(Ref<FormSubmission>&& submission)
438 {
439     ASSERT(m_frame.page());
440
441     // FIXME: Do we need special handling for form submissions where the URL is the same
442     // as the current one except for the fragment part? See scheduleLocationChange above.
443
444     // Handle a location change of a page with no document as a special case.
445     // This may happen when a frame changes the location of another frame.
446     bool duringLoad = !m_frame.loader().stateMachine().committedFirstRealDocumentLoad();
447
448     // If this is a child frame and the form submission was triggered by a script, lock the back/forward list
449     // to match IE and Opera.
450     // See https://bugs.webkit.org/show_bug.cgi?id=32383 for the original motivation for this.
451     LockBackForwardList lockBackForwardList = mustLockBackForwardList(m_frame);
452     if (lockBackForwardList == LockBackForwardList::No
453         && (submission->state().formSubmissionTrigger() == SubmittedByJavaScript && m_frame.tree().parent() && !UserGestureIndicator::processingUserGesture())) {
454         lockBackForwardList = LockBackForwardList::Yes;
455     }
456     
457     schedule(std::make_unique<ScheduledFormSubmission>(WTFMove(submission), lockBackForwardList, duringLoad));
458 }
459
460 void NavigationScheduler::scheduleRefresh(Document& initiatingDocument)
461 {
462     if (!shouldScheduleNavigation())
463         return;
464     const URL& url = m_frame.document()->url();
465     if (url.isEmpty())
466         return;
467
468     schedule(std::make_unique<ScheduledRefresh>(initiatingDocument, &m_frame.document()->securityOrigin(), url, m_frame.loader().outgoingReferrer()));
469 }
470
471 void NavigationScheduler::scheduleHistoryNavigation(int steps)
472 {
473     LOG(History, "NavigationScheduler %p scheduleHistoryNavigation(%d) - shouldSchedule %d", this, steps, shouldScheduleNavigation());
474     if (!shouldScheduleNavigation())
475         return;
476
477     // Invalid history navigations (such as history.forward() during a new load) have the side effect of cancelling any scheduled
478     // redirects. We also avoid the possibility of cancelling the current load by avoiding the scheduled redirection altogether.
479     BackForwardController& backForward = m_frame.page()->backForward();
480     if ((steps > 0 && static_cast<unsigned>(steps) > backForward.forwardCount())
481         || (steps < 0 && static_cast<unsigned>(-steps) > backForward.backCount())) {
482         cancel();
483         return;
484     }
485
486     // In all other cases, schedule the history traversal to occur asynchronously.
487     schedule(std::make_unique<ScheduledHistoryNavigation>(steps));
488 }
489
490 void NavigationScheduler::schedulePageBlock(Document& originDocument)
491 {
492     if (shouldScheduleNavigation())
493         schedule(std::make_unique<ScheduledPageBlock>(originDocument));
494 }
495
496 void NavigationScheduler::timerFired()
497 {
498     if (!m_frame.page())
499         return;
500     if (m_frame.page()->defersLoading()) {
501         InspectorInstrumentation::frameClearedScheduledNavigation(m_frame);
502         return;
503     }
504
505     Ref<Frame> protect(m_frame);
506
507     std::unique_ptr<ScheduledNavigation> redirect = WTFMove(m_redirect);
508     LOG(History, "NavigationScheduler %p timerFired - firing redirect %p", this, redirect.get());
509
510     redirect->fire(m_frame);
511     InspectorInstrumentation::frameClearedScheduledNavigation(m_frame);
512 }
513
514 void NavigationScheduler::schedule(std::unique_ptr<ScheduledNavigation> redirect)
515 {
516     ASSERT(m_frame.page());
517
518     Ref<Frame> protect(m_frame);
519
520     // If a redirect was scheduled during a load, then stop the current load.
521     // Otherwise when the current load transitions from a provisional to a 
522     // committed state, pending redirects may be cancelled. 
523     if (redirect->wasDuringLoad()) {
524         if (DocumentLoader* provisionalDocumentLoader = m_frame.loader().provisionalDocumentLoader())
525             provisionalDocumentLoader->stopLoading();
526         m_frame.loader().stopLoading(UnloadEventPolicyUnloadAndPageHide);
527     }
528
529     cancel();
530     m_redirect = WTFMove(redirect);
531
532     if (!m_frame.loader().isComplete() && m_redirect->isLocationChange())
533         m_frame.loader().completed();
534
535     if (!m_frame.page())
536         return;
537
538     startTimer();
539 }
540
541 void NavigationScheduler::startTimer()
542 {
543     if (!m_redirect)
544         return;
545
546     ASSERT(m_frame.page());
547     if (m_timer.isActive())
548         return;
549     if (!m_redirect->shouldStartTimer(m_frame))
550         return;
551
552     Seconds delay = 1_s * m_redirect->delay();
553     m_timer.startOneShot(delay);
554     InspectorInstrumentation::frameScheduledNavigation(m_frame, delay);
555     m_redirect->didStartTimer(m_frame, m_timer); // m_redirect may be null on return (e.g. the client canceled the load)
556 }
557
558 void NavigationScheduler::cancel(NewLoadInProgress newLoadInProgress)
559 {
560     LOG(History, "NavigationScheduler %p cancel(newLoadInProgress=%d)", this, newLoadInProgress == NewLoadInProgress::Yes);
561
562     if (m_timer.isActive())
563         InspectorInstrumentation::frameClearedScheduledNavigation(m_frame);
564     m_timer.stop();
565
566     if (auto redirect = WTFMove(m_redirect))
567         redirect->didStopTimer(m_frame, newLoadInProgress);
568 }
569
570 } // namespace WebCore