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