3bcb1a5eadc094bf07f07bfa165080be16499514
[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 "ScriptController.h"
54 #include "UserGestureIndicator.h"
55 #include <wtf/CurrentTime.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_navigationInitiatedByMainFrame = NavigationInitiatedByMainFrame::Yes;
86         }
87     }
88     virtual ~ScheduledNavigation() { }
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&, bool /* 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     NavigationInitiatedByMainFrame navigationInitiatedByMainFrame() const { return m_navigationInitiatedByMainFrame; };
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     NavigationInitiatedByMainFrame m_navigationInitiatedByMainFrame { NavigationInitiatedByMainFrame::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 fire(Frame& frame) override
131     {
132         UserGestureIndicator gestureIndicator { userGestureToForward() };
133
134         ResourceRequest resourceRequest { m_url, m_referrer, UseProtocolCachePolicy };
135         FrameLoadRequest frameLoadRequest { m_initiatingDocument.get(), *m_securityOrigin, resourceRequest, "_self", lockHistory(), lockBackForwardList(), MaybeSendReferrer, AllowNavigationToInvalidURL::Yes, NewFrameOpenerPolicy::Allow, shouldOpenExternalURLs(), navigationInitiatedByMainFrame() };
136
137         frame.loader().changeLocation(WTFMove(frameLoadRequest));
138     }
139
140     void didStartTimer(Frame& frame, Timer& timer) override
141     {
142         if (m_haveToldClient)
143             return;
144         m_haveToldClient = true;
145
146         UserGestureIndicator gestureIndicator(userGestureToForward());
147         frame.loader().clientRedirected(m_url, delay(), currentTime() + timer.nextFireInterval().value(), lockBackForwardList());
148     }
149
150     void didStopTimer(Frame& frame, bool newLoadInProgress) override
151     {
152         if (!m_haveToldClient)
153             return;
154
155         // Do not set a UserGestureIndicator because
156         // clientRedirectCancelledOrFinished() is also called from many places
157         // inside FrameLoader, where the gesture state is not set and is in
158         // fact unavailable. We need to be consistent with them, otherwise the
159         // gesture state will sometimes be set and sometimes not within
160         // dispatchDidCancelClientRedirect().
161         frame.loader().clientRedirectCancelledOrFinished(newLoadInProgress);
162     }
163
164     Document& initiatingDocument() { return m_initiatingDocument.get(); }
165     SecurityOrigin* securityOrigin() const { return m_securityOrigin.get(); }
166     const URL& url() const { return m_url; }
167     String referrer() const { return m_referrer; }
168
169 private:
170     Ref<Document> m_initiatingDocument;
171     RefPtr<SecurityOrigin> m_securityOrigin;
172     URL m_url;
173     String m_referrer;
174     bool m_haveToldClient { false };
175 };
176
177 class ScheduledRedirect : public ScheduledURLNavigation {
178 public:
179     ScheduledRedirect(Document& initiatingDocument, double delay, SecurityOrigin* securityOrigin, const URL& url, LockHistory lockHistory, LockBackForwardList lockBackForwardList)
180         : ScheduledURLNavigation(initiatingDocument, delay, securityOrigin, url, String(), lockHistory, lockBackForwardList, false, false)
181     {
182         clearUserGesture();
183     }
184
185     bool shouldStartTimer(Frame& frame) override
186     {
187         return frame.loader().allAncestorsAreComplete();
188     }
189
190     void fire(Frame& frame) override
191     {
192         UserGestureIndicator gestureIndicator { userGestureToForward() };
193
194         bool refresh = equalIgnoringFragmentIdentifier(frame.document()->url(), url());
195         ResourceRequest resourceRequest { url(), referrer(), refresh ? ReloadIgnoringCacheData : UseProtocolCachePolicy };
196         FrameLoadRequest frameLoadRequest { initiatingDocument(), *securityOrigin(), resourceRequest, "_self", lockHistory(), lockBackForwardList(), MaybeSendReferrer, AllowNavigationToInvalidURL::No, NewFrameOpenerPolicy::Allow, shouldOpenExternalURLs(), navigationInitiatedByMainFrame() };
197
198         frame.loader().changeLocation(WTFMove(frameLoadRequest));
199     }
200 };
201
202 class ScheduledLocationChange : public ScheduledURLNavigation {
203 public:
204     ScheduledLocationChange(Document& initiatingDocument, SecurityOrigin* securityOrigin, const URL& url, const String& referrer, LockHistory lockHistory, LockBackForwardList lockBackForwardList, bool duringLoad)
205         : ScheduledURLNavigation(initiatingDocument, 0.0, securityOrigin, url, referrer, lockHistory, lockBackForwardList, duringLoad, true) { }
206
207     void fire(Frame& frame) override
208     {
209         UserGestureIndicator gestureIndicator { userGestureToForward() };
210
211         ResourceRequest resourceRequest { url(), referrer(), UseProtocolCachePolicy };
212         FrameLoadRequest frameLoadRequest { initiatingDocument(), *securityOrigin(), resourceRequest, "_self", lockHistory(), lockBackForwardList(), MaybeSendReferrer, AllowNavigationToInvalidURL::No, NewFrameOpenerPolicy::Allow, shouldOpenExternalURLs(), navigationInitiatedByMainFrame() };
213
214         frame.loader().changeLocation(WTFMove(frameLoadRequest));
215     }
216 };
217
218 class ScheduledRefresh : public ScheduledURLNavigation {
219 public:
220     ScheduledRefresh(Document& initiatingDocument, SecurityOrigin* securityOrigin, const URL& url, const String& referrer)
221         : ScheduledURLNavigation(initiatingDocument, 0.0, securityOrigin, url, referrer, LockHistory::Yes, LockBackForwardList::Yes, false, true)
222     {
223     }
224
225     void fire(Frame& frame) override
226     {
227         UserGestureIndicator gestureIndicator { userGestureToForward() };
228
229         ResourceRequest resourceRequest { url(), referrer(), ReloadIgnoringCacheData };
230         FrameLoadRequest frameLoadRequest { initiatingDocument(), *securityOrigin(), resourceRequest, "_self", lockHistory(), lockBackForwardList(), MaybeSendReferrer, AllowNavigationToInvalidURL::Yes, NewFrameOpenerPolicy::Allow, shouldOpenExternalURLs(), navigationInitiatedByMainFrame() };
231
232         frame.loader().changeLocation(WTFMove(frameLoadRequest));
233     }
234 };
235
236 class ScheduledHistoryNavigation : public ScheduledNavigation {
237 public:
238     explicit ScheduledHistoryNavigation(int historySteps)
239         : ScheduledNavigation(0, LockHistory::No, LockBackForwardList::No, false, true)
240         , m_historySteps(historySteps)
241     {
242     }
243
244     void fire(Frame& frame) override
245     {
246         UserGestureIndicator gestureIndicator(userGestureToForward());
247
248         if (!m_historySteps) {
249             // Special case for go(0) from a frame -> reload only the frame
250             // To follow Firefox and IE's behavior, history reload can only navigate the self frame.
251             frame.loader().urlSelected(frame.document()->url(), "_self", 0, lockHistory(), lockBackForwardList(), MaybeSendReferrer, shouldOpenExternalURLs());
252             return;
253         }
254         
255         // go(i!=0) from a frame navigates into the history of the frame only,
256         // in both IE and NS (but not in Mozilla). We can't easily do that.
257         frame.page()->backForward().goBackOrForward(m_historySteps);
258     }
259
260 private:
261     int m_historySteps;
262 };
263
264 class ScheduledFormSubmission : public ScheduledNavigation {
265 public:
266     ScheduledFormSubmission(Ref<FormSubmission>&& submission, LockBackForwardList lockBackForwardList, bool duringLoad)
267         : ScheduledNavigation(0, submission->lockHistory(), lockBackForwardList, duringLoad, true, submission->state().sourceDocument().shouldOpenExternalURLsPolicyToPropagate())
268         , m_submission(WTFMove(submission))
269     {
270     }
271
272     void fire(Frame& frame) override
273     {
274         UserGestureIndicator gestureIndicator(userGestureToForward());
275
276         // The submitForm function will find a target frame before using the redirection timer.
277         // Now that the timer has fired, we need to repeat the security check which normally is done when
278         // selecting a target, in case conditions have changed. Other code paths avoid this by targeting
279         // without leaving a time window. If we fail the check just silently drop the form submission.
280         auto& requestingDocument = m_submission->state().sourceDocument();
281         if (!requestingDocument.canNavigate(&frame))
282             return;
283         FrameLoadRequest frameLoadRequest { requestingDocument, requestingDocument.securityOrigin(), { }, { }, lockHistory(), lockBackForwardList(), MaybeSendReferrer, AllowNavigationToInvalidURL::Yes, NewFrameOpenerPolicy::Allow, shouldOpenExternalURLs(), navigationInitiatedByMainFrame() };
284         m_submission->populateFrameLoadRequest(frameLoadRequest);
285         frame.loader().loadFrameRequest(WTFMove(frameLoadRequest), m_submission->event(), &m_submission->state());
286     }
287
288     void didStartTimer(Frame& frame, Timer& timer) override
289     {
290         if (m_haveToldClient)
291             return;
292         m_haveToldClient = true;
293
294         UserGestureIndicator gestureIndicator(userGestureToForward());
295         frame.loader().clientRedirected(m_submission->requestURL(), delay(), currentTime() + timer.nextFireInterval().value(), lockBackForwardList());
296     }
297
298     void didStopTimer(Frame& frame, bool newLoadInProgress) override
299     {
300         if (!m_haveToldClient)
301             return;
302
303         // Do not set a UserGestureIndicator because
304         // clientRedirectCancelledOrFinished() is also called from many places
305         // inside FrameLoader, where the gesture state is not set and is in
306         // fact unavailable. We need to be consistent with them, otherwise the
307         // gesture state will sometimes be set and sometimes not within
308         // dispatchDidCancelClientRedirect().
309         frame.loader().clientRedirectCancelledOrFinished(newLoadInProgress);
310     }
311
312 private:
313     Ref<FormSubmission> m_submission;
314     bool m_haveToldClient { false };
315 };
316
317 class ScheduledPageBlock final : public ScheduledNavigation {
318 public:
319     ScheduledPageBlock(Document& originDocument)
320         : ScheduledNavigation(0, LockHistory::Yes, LockBackForwardList::Yes, false, false)
321         , m_originDocument(originDocument)
322     {
323     }
324
325     void fire(Frame& frame) override
326     {
327         UserGestureIndicator gestureIndicator { userGestureToForward() };
328
329         ResourceResponse replacementResponse { m_originDocument.url(), ASCIILiteral("text/plain"), 0, ASCIILiteral("UTF-8") };
330         SubstituteData replacementData { SharedBuffer::create(), m_originDocument.url(), replacementResponse, SubstituteData::SessionHistoryVisibility::Hidden };
331
332         ResourceRequest resourceRequest { m_originDocument.url(), emptyString(), ReloadIgnoringCacheData };
333         FrameLoadRequest frameLoadRequest { m_originDocument, m_originDocument.securityOrigin(), resourceRequest, { }, lockHistory(), lockBackForwardList(), MaybeSendReferrer, AllowNavigationToInvalidURL::Yes, NewFrameOpenerPolicy::Allow, shouldOpenExternalURLs(), navigationInitiatedByMainFrame() };
334         frameLoadRequest.setSubstituteData(replacementData);
335         frame.loader().load(WTFMove(frameLoadRequest));
336     }
337
338 private:
339     Document& m_originDocument;
340 };
341
342 NavigationScheduler::NavigationScheduler(Frame& frame)
343     : m_frame(frame)
344     , m_timer(*this, &NavigationScheduler::timerFired)
345 {
346 }
347
348 NavigationScheduler::~NavigationScheduler()
349 {
350 }
351
352 bool NavigationScheduler::redirectScheduledDuringLoad()
353 {
354     return m_redirect && m_redirect->wasDuringLoad();
355 }
356
357 bool NavigationScheduler::locationChangePending()
358 {
359     return m_redirect && m_redirect->isLocationChange();
360 }
361
362 void NavigationScheduler::clear()
363 {
364     if (m_timer.isActive())
365         InspectorInstrumentation::frameClearedScheduledNavigation(m_frame);
366     m_timer.stop();
367     m_redirect = nullptr;
368 }
369
370 inline bool NavigationScheduler::shouldScheduleNavigation() const
371 {
372     return m_frame.page();
373 }
374
375 inline bool NavigationScheduler::shouldScheduleNavigation(const URL& url) const
376 {
377     if (!shouldScheduleNavigation())
378         return false;
379     if (protocolIsJavaScript(url))
380         return true;
381     return NavigationDisabler::isNavigationAllowed(m_frame);
382 }
383
384 void NavigationScheduler::scheduleRedirect(Document& initiatingDocument, double delay, const URL& url)
385 {
386     if (!shouldScheduleNavigation(url))
387         return;
388     if (delay < 0 || delay > INT_MAX / 1000)
389         return;
390     if (url.isEmpty())
391         return;
392
393     // We want a new back/forward list item if the refresh timeout is > 1 second.
394     if (!m_redirect || delay <= m_redirect->delay()) {
395         auto lockBackForwardList = delay <= 1 ? LockBackForwardList::Yes : LockBackForwardList::No;
396         schedule(std::make_unique<ScheduledRedirect>(initiatingDocument, delay, &m_frame.document()->securityOrigin(), url, LockHistory::Yes, lockBackForwardList));
397     }
398 }
399
400 LockBackForwardList NavigationScheduler::mustLockBackForwardList(Frame& targetFrame)
401 {
402     // Non-user navigation before the page has finished firing onload should not create a new back/forward item.
403     // See https://webkit.org/b/42861 for the original motivation for this.    
404     if (!UserGestureIndicator::processingUserGesture() && targetFrame.loader().documentLoader() && !targetFrame.loader().documentLoader()->wasOnloadDispatched())
405         return LockBackForwardList::Yes;
406     
407     // Navigation of a subframe during loading of an ancestor frame does not create a new back/forward item.
408     // The definition of "during load" is any time before all handlers for the load event have been run.
409     // See https://bugs.webkit.org/show_bug.cgi?id=14957 for the original motivation for this.
410     for (Frame* ancestor = targetFrame.tree().parent(); ancestor; ancestor = ancestor->tree().parent()) {
411         Document* document = ancestor->document();
412         if (!ancestor->loader().isComplete() || (document && document->processingLoadEvent()))
413             return LockBackForwardList::Yes;
414     }
415     return LockBackForwardList::No;
416 }
417
418 void NavigationScheduler::scheduleLocationChange(Document& initiatingDocument, SecurityOrigin& securityOrigin, const URL& url, const String& referrer, LockHistory lockHistory, LockBackForwardList lockBackForwardList)
419 {
420     if (!shouldScheduleNavigation(url))
421         return;
422
423     if (lockBackForwardList == LockBackForwardList::No)
424         lockBackForwardList = mustLockBackForwardList(m_frame);
425
426     FrameLoader& loader = m_frame.loader();
427
428     // If the URL we're going to navigate to is the same as the current one, except for the
429     // fragment part, we don't need to schedule the location change.
430     if (url.hasFragmentIdentifier() && equalIgnoringFragmentIdentifier(m_frame.document()->url(), url)) {
431         ResourceRequest resourceRequest { m_frame.document()->completeURL(url), referrer, UseProtocolCachePolicy };
432         auto* frame = lexicalFrameFromCommonVM();
433         auto navigationInitiatedByMainFrame = frame && frame->isMainFrame() ? NavigationInitiatedByMainFrame::Yes : NavigationInitiatedByMainFrame::Unknown;
434         
435         FrameLoadRequest frameLoadRequest { initiatingDocument, securityOrigin, resourceRequest, ASCIILiteral("_self"), lockHistory, lockBackForwardList, MaybeSendReferrer, AllowNavigationToInvalidURL::No, NewFrameOpenerPolicy::Allow, initiatingDocument.shouldOpenExternalURLsPolicyToPropagate(), navigationInitiatedByMainFrame };
436         loader.changeLocation(WTFMove(frameLoadRequest));
437         return;
438     }
439
440     // Handle a location change of a page with no document as a special case.
441     // This may happen when a frame changes the location of another frame.
442     bool duringLoad = !loader.stateMachine().committedFirstRealDocumentLoad();
443
444     schedule(std::make_unique<ScheduledLocationChange>(initiatingDocument, &securityOrigin, url, referrer, lockHistory, lockBackForwardList, duringLoad));
445 }
446
447 void NavigationScheduler::scheduleFormSubmission(Ref<FormSubmission>&& submission)
448 {
449     ASSERT(m_frame.page());
450
451     // FIXME: Do we need special handling for form submissions where the URL is the same
452     // as the current one except for the fragment part? See scheduleLocationChange above.
453
454     // Handle a location change of a page with no document as a special case.
455     // This may happen when a frame changes the location of another frame.
456     bool duringLoad = !m_frame.loader().stateMachine().committedFirstRealDocumentLoad();
457
458     // If this is a child frame and the form submission was triggered by a script, lock the back/forward list
459     // to match IE and Opera.
460     // See https://bugs.webkit.org/show_bug.cgi?id=32383 for the original motivation for this.
461     LockBackForwardList lockBackForwardList = mustLockBackForwardList(m_frame);
462     if (lockBackForwardList == LockBackForwardList::No
463         && (submission->state().formSubmissionTrigger() == SubmittedByJavaScript && m_frame.tree().parent() && !UserGestureIndicator::processingUserGesture())) {
464         lockBackForwardList = LockBackForwardList::Yes;
465     }
466     
467     schedule(std::make_unique<ScheduledFormSubmission>(WTFMove(submission), lockBackForwardList, duringLoad));
468 }
469
470 void NavigationScheduler::scheduleRefresh(Document& initiatingDocument)
471 {
472     if (!shouldScheduleNavigation())
473         return;
474     const URL& url = m_frame.document()->url();
475     if (url.isEmpty())
476         return;
477
478     schedule(std::make_unique<ScheduledRefresh>(initiatingDocument, &m_frame.document()->securityOrigin(), url, m_frame.loader().outgoingReferrer()));
479 }
480
481 void NavigationScheduler::scheduleHistoryNavigation(int steps)
482 {
483     LOG(History, "NavigationScheduler %p scheduleHistoryNavigation(%d) - shouldSchedule %d", this, steps, shouldScheduleNavigation());
484     if (!shouldScheduleNavigation())
485         return;
486
487     // Invalid history navigations (such as history.forward() during a new load) have the side effect of cancelling any scheduled
488     // redirects. We also avoid the possibility of cancelling the current load by avoiding the scheduled redirection altogether.
489     BackForwardController& backForward = m_frame.page()->backForward();
490     if (steps > backForward.forwardCount() || -steps > backForward.backCount()) {
491         cancel();
492         return;
493     }
494
495     // In all other cases, schedule the history traversal to occur asynchronously.
496     schedule(std::make_unique<ScheduledHistoryNavigation>(steps));
497 }
498
499 void NavigationScheduler::schedulePageBlock(Document& originDocument)
500 {
501     if (shouldScheduleNavigation())
502         schedule(std::make_unique<ScheduledPageBlock>(originDocument));
503 }
504
505 void NavigationScheduler::timerFired()
506 {
507     if (!m_frame.page())
508         return;
509     if (m_frame.page()->defersLoading()) {
510         InspectorInstrumentation::frameClearedScheduledNavigation(m_frame);
511         return;
512     }
513
514     Ref<Frame> protect(m_frame);
515
516     std::unique_ptr<ScheduledNavigation> redirect = WTFMove(m_redirect);
517     LOG(History, "NavigationScheduler %p timerFired - firing redirect %p", this, redirect.get());
518
519     redirect->fire(m_frame);
520     InspectorInstrumentation::frameClearedScheduledNavigation(m_frame);
521 }
522
523 void NavigationScheduler::schedule(std::unique_ptr<ScheduledNavigation> redirect)
524 {
525     ASSERT(m_frame.page());
526
527     Ref<Frame> protect(m_frame);
528
529     // If a redirect was scheduled during a load, then stop the current load.
530     // Otherwise when the current load transitions from a provisional to a 
531     // committed state, pending redirects may be cancelled. 
532     if (redirect->wasDuringLoad()) {
533         if (DocumentLoader* provisionalDocumentLoader = m_frame.loader().provisionalDocumentLoader())
534             provisionalDocumentLoader->stopLoading();
535         m_frame.loader().stopLoading(UnloadEventPolicyUnloadAndPageHide);
536     }
537
538     cancel();
539     m_redirect = WTFMove(redirect);
540
541     if (!m_frame.loader().isComplete() && m_redirect->isLocationChange())
542         m_frame.loader().completed();
543
544     if (!m_frame.page())
545         return;
546
547     startTimer();
548 }
549
550 void NavigationScheduler::startTimer()
551 {
552     if (!m_redirect)
553         return;
554
555     ASSERT(m_frame.page());
556     if (m_timer.isActive())
557         return;
558     if (!m_redirect->shouldStartTimer(m_frame))
559         return;
560
561     Seconds delay = 1_s * m_redirect->delay();
562     m_timer.startOneShot(delay);
563     InspectorInstrumentation::frameScheduledNavigation(m_frame, delay);
564     m_redirect->didStartTimer(m_frame, m_timer); // m_redirect may be null on return (e.g. the client canceled the load)
565 }
566
567 void NavigationScheduler::cancel(bool newLoadInProgress)
568 {
569     LOG(History, "NavigationScheduler %p cancel(newLoadInProgress=%d)", this, newLoadInProgress);
570
571     if (m_timer.isActive())
572         InspectorInstrumentation::frameClearedScheduledNavigation(m_frame);
573     m_timer.stop();
574
575     if (std::unique_ptr<ScheduledNavigation> redirect = WTFMove(m_redirect))
576         redirect->didStopTimer(m_frame, newLoadInProgress);
577 }
578
579 } // namespace WebCore