bdbad245d1b51ecfbbda4659b537bb46e7dbfd6c
[WebKit-https.git] / Source / WebCore / loader / NavigationScheduler.cpp
1 /*
2  * Copyright (C) 2006, 2007, 2008, 2009, 2010 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 Computer, 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 "DOMWindow.h"
37 #include "DocumentLoader.h"
38 #include "Event.h"
39 #include "FormState.h"
40 #include "FormSubmission.h"
41 #include "Frame.h"
42 #include "FrameLoadRequest.h"
43 #include "FrameLoader.h"
44 #include "FrameLoaderStateMachine.h"
45 #include "HTMLFormElement.h"
46 #include "HTMLFrameOwnerElement.h"
47 #include "HistoryItem.h"
48 #include "InspectorInstrumentation.h"
49 #include "Page.h"
50 #include "ScriptController.h"
51 #include "UserGestureIndicator.h"
52 #include <wtf/CurrentTime.h>
53 #include <wtf/Ref.h>
54
55 namespace WebCore {
56
57 unsigned NavigationDisablerForBeforeUnload::s_navigationDisableCount = 0;
58
59 class ScheduledNavigation {
60     WTF_MAKE_NONCOPYABLE(ScheduledNavigation); WTF_MAKE_FAST_ALLOCATED;
61 public:
62     ScheduledNavigation(double delay, bool lockHistory, bool lockBackForwardList, bool wasDuringLoad, bool isLocationChange)
63         : m_delay(delay)
64         , m_lockHistory(lockHistory)
65         , m_lockBackForwardList(lockBackForwardList)
66         , m_wasDuringLoad(wasDuringLoad)
67         , m_isLocationChange(isLocationChange)
68         , m_wasUserGesture(ScriptController::processingUserGesture())
69     {
70     }
71     virtual ~ScheduledNavigation() { }
72
73     virtual void fire(Frame&) = 0;
74
75     virtual bool shouldStartTimer(Frame&) { return true; }
76     virtual void didStartTimer(Frame&, Timer<NavigationScheduler>&) { }
77     virtual void didStopTimer(Frame&, bool /* newLoadInProgress */) { }
78
79     double delay() const { return m_delay; }
80     bool lockHistory() const { return m_lockHistory; }
81     bool lockBackForwardList() const { return m_lockBackForwardList; }
82     bool wasDuringLoad() const { return m_wasDuringLoad; }
83     bool isLocationChange() const { return m_isLocationChange; }
84     bool wasUserGesture() const { return m_wasUserGesture; }
85
86 protected:
87     void clearUserGesture() { m_wasUserGesture = false; }
88
89 private:
90     double m_delay;
91     bool m_lockHistory;
92     bool m_lockBackForwardList;
93     bool m_wasDuringLoad;
94     bool m_isLocationChange;
95     bool m_wasUserGesture;
96 };
97
98 class ScheduledURLNavigation : public ScheduledNavigation {
99 protected:
100     ScheduledURLNavigation(double delay, SecurityOrigin* securityOrigin, const String& url, const String& referrer, bool lockHistory, bool lockBackForwardList, bool duringLoad, bool isLocationChange)
101         : ScheduledNavigation(delay, lockHistory, lockBackForwardList, duringLoad, isLocationChange)
102         , m_securityOrigin(securityOrigin)
103         , m_url(url)
104         , m_referrer(referrer)
105         , m_haveToldClient(false)
106     {
107     }
108
109     virtual void fire(Frame& frame) OVERRIDE
110     {
111         UserGestureIndicator gestureIndicator(wasUserGesture() ? DefinitelyProcessingUserGesture : DefinitelyNotProcessingUserGesture);
112         frame.loader().changeLocation(m_securityOrigin.get(), URL(ParsedURLString, m_url), m_referrer, lockHistory(), lockBackForwardList(), false);
113     }
114
115     virtual void didStartTimer(Frame& frame, Timer<NavigationScheduler>& timer) OVERRIDE
116     {
117         if (m_haveToldClient)
118             return;
119         m_haveToldClient = true;
120
121         UserGestureIndicator gestureIndicator(wasUserGesture() ? DefinitelyProcessingUserGesture : DefinitelyNotProcessingUserGesture);
122         frame.loader().clientRedirected(URL(ParsedURLString, m_url), delay(), currentTime() + timer.nextFireInterval(), lockBackForwardList());
123     }
124
125     virtual void didStopTimer(Frame& frame, bool newLoadInProgress) OVERRIDE
126     {
127         if (!m_haveToldClient)
128             return;
129
130         // Do not set a UserGestureIndicator because
131         // clientRedirectCancelledOrFinished() is also called from many places
132         // inside FrameLoader, where the gesture state is not set and is in
133         // fact unavailable. We need to be consistent with them, otherwise the
134         // gesture state will sometimes be set and sometimes not within
135         // dispatchDidCancelClientRedirect().
136         frame.loader().clientRedirectCancelledOrFinished(newLoadInProgress);
137     }
138
139     SecurityOrigin* securityOrigin() const { return m_securityOrigin.get(); }
140     String url() const { return m_url; }
141     String referrer() const { return m_referrer; }
142
143 private:
144     RefPtr<SecurityOrigin> m_securityOrigin;
145     String m_url;
146     String m_referrer;
147     bool m_haveToldClient;
148 };
149
150 class ScheduledRedirect : public ScheduledURLNavigation {
151 public:
152     ScheduledRedirect(double delay, SecurityOrigin* securityOrigin, const String& url, bool lockHistory, bool lockBackForwardList)
153         : ScheduledURLNavigation(delay, securityOrigin, url, String(), lockHistory, lockBackForwardList, false, false)
154     {
155         clearUserGesture();
156     }
157
158     virtual bool shouldStartTimer(Frame& frame) OVERRIDE
159     {
160         return frame.loader().allAncestorsAreComplete();
161     }
162
163     virtual void fire(Frame& frame) OVERRIDE
164     {
165         UserGestureIndicator gestureIndicator(wasUserGesture() ? DefinitelyProcessingUserGesture : DefinitelyNotProcessingUserGesture);
166         bool refresh = equalIgnoringFragmentIdentifier(frame.document()->url(), URL(ParsedURLString, url()));
167         frame.loader().changeLocation(securityOrigin(), URL(ParsedURLString, url()), referrer(), lockHistory(), lockBackForwardList(), refresh);
168     }
169 };
170
171 class ScheduledLocationChange : public ScheduledURLNavigation {
172 public:
173     ScheduledLocationChange(SecurityOrigin* securityOrigin, const String& url, const String& referrer, bool lockHistory, bool lockBackForwardList, bool duringLoad)
174         : ScheduledURLNavigation(0.0, securityOrigin, url, referrer, lockHistory, lockBackForwardList, duringLoad, true) { }
175 };
176
177 class ScheduledRefresh : public ScheduledURLNavigation {
178 public:
179     ScheduledRefresh(SecurityOrigin* securityOrigin, const String& url, const String& referrer)
180         : ScheduledURLNavigation(0.0, securityOrigin, url, referrer, true, true, false, true)
181     {
182     }
183
184     virtual void fire(Frame& frame) OVERRIDE
185     {
186         UserGestureIndicator gestureIndicator(wasUserGesture() ? DefinitelyProcessingUserGesture : DefinitelyNotProcessingUserGesture);
187         frame.loader().changeLocation(securityOrigin(), URL(ParsedURLString, url()), referrer(), lockHistory(), lockBackForwardList(), true);
188     }
189 };
190
191 class ScheduledHistoryNavigation : public ScheduledNavigation {
192 public:
193     explicit ScheduledHistoryNavigation(int historySteps)
194         : ScheduledNavigation(0, false, false, false, true)
195         , m_historySteps(historySteps)
196     {
197     }
198
199     virtual void fire(Frame& frame) OVERRIDE
200     {
201         UserGestureIndicator gestureIndicator(wasUserGesture() ? DefinitelyProcessingUserGesture : DefinitelyNotProcessingUserGesture);
202
203         if (!m_historySteps) {
204             // Special case for go(0) from a frame -> reload only the frame
205             // To follow Firefox and IE's behavior, history reload can only navigate the self frame.
206             frame.loader().urlSelected(frame.document()->url(), "_self", 0, lockHistory(), lockBackForwardList(), MaybeSendReferrer);
207             return;
208         }
209         
210         // go(i!=0) from a frame navigates into the history of the frame only,
211         // in both IE and NS (but not in Mozilla). We can't easily do that.
212         frame.page()->backForward().goBackOrForward(m_historySteps);
213     }
214
215 private:
216     int m_historySteps;
217 };
218
219 class ScheduledFormSubmission : public ScheduledNavigation {
220 public:
221     ScheduledFormSubmission(PassRefPtr<FormSubmission> submission, bool lockBackForwardList, bool duringLoad)
222         : ScheduledNavigation(0, submission->lockHistory(), lockBackForwardList, duringLoad, true)
223         , m_submission(submission)
224         , m_haveToldClient(false)
225     {
226         ASSERT(m_submission->state());
227     }
228
229     virtual void fire(Frame& frame) OVERRIDE
230     {
231         UserGestureIndicator gestureIndicator(wasUserGesture() ? DefinitelyProcessingUserGesture : DefinitelyNotProcessingUserGesture);
232
233         // The submitForm function will find a target frame before using the redirection timer.
234         // Now that the timer has fired, we need to repeat the security check which normally is done when
235         // selecting a target, in case conditions have changed. Other code paths avoid this by targeting
236         // without leaving a time window. If we fail the check just silently drop the form submission.
237         Document* requestingDocument = m_submission->state()->sourceDocument();
238         if (!requestingDocument->canNavigate(&frame))
239             return;
240         FrameLoadRequest frameRequest(requestingDocument->securityOrigin());
241         m_submission->populateFrameLoadRequest(frameRequest);
242         frame.loader().loadFrameRequest(frameRequest, lockHistory(), lockBackForwardList(), m_submission->event(), m_submission->state(), MaybeSendReferrer);
243     }
244     
245     virtual void didStartTimer(Frame& frame, Timer<NavigationScheduler>& timer) OVERRIDE
246     {
247         if (m_haveToldClient)
248             return;
249         m_haveToldClient = true;
250
251         UserGestureIndicator gestureIndicator(wasUserGesture() ? DefinitelyProcessingUserGesture : DefinitelyNotProcessingUserGesture);
252         frame.loader().clientRedirected(m_submission->requestURL(), delay(), currentTime() + timer.nextFireInterval(), lockBackForwardList());
253     }
254
255     virtual void didStopTimer(Frame& frame, bool newLoadInProgress) OVERRIDE
256     {
257         if (!m_haveToldClient)
258             return;
259
260         // Do not set a UserGestureIndicator because
261         // clientRedirectCancelledOrFinished() is also called from many places
262         // inside FrameLoader, where the gesture state is not set and is in
263         // fact unavailable. We need to be consistent with them, otherwise the
264         // gesture state will sometimes be set and sometimes not within
265         // dispatchDidCancelClientRedirect().
266         frame.loader().clientRedirectCancelledOrFinished(newLoadInProgress);
267     }
268
269 private:
270     RefPtr<FormSubmission> m_submission;
271     bool m_haveToldClient;
272 };
273
274 NavigationScheduler::NavigationScheduler(Frame& frame)
275     : m_frame(frame)
276     , m_timer(this, &NavigationScheduler::timerFired)
277 {
278 }
279
280 NavigationScheduler::~NavigationScheduler()
281 {
282 }
283
284 bool NavigationScheduler::redirectScheduledDuringLoad()
285 {
286     return m_redirect && m_redirect->wasDuringLoad();
287 }
288
289 bool NavigationScheduler::locationChangePending()
290 {
291     return m_redirect && m_redirect->isLocationChange();
292 }
293
294 void NavigationScheduler::clear()
295 {
296     if (m_timer.isActive())
297         InspectorInstrumentation::frameClearedScheduledNavigation(m_frame);
298     m_timer.stop();
299     m_redirect = nullptr;
300 }
301
302 inline bool NavigationScheduler::shouldScheduleNavigation() const
303 {
304     return m_frame.page();
305 }
306
307 inline bool NavigationScheduler::shouldScheduleNavigation(const String& url) const
308 {
309     return shouldScheduleNavigation() && (protocolIsJavaScript(url) || NavigationDisablerForBeforeUnload::isNavigationAllowed());
310 }
311
312 void NavigationScheduler::scheduleRedirect(double delay, const String& url)
313 {
314     if (!shouldScheduleNavigation(url))
315         return;
316     if (delay < 0 || delay > INT_MAX / 1000)
317         return;
318     if (url.isEmpty())
319         return;
320
321     // We want a new back/forward list item if the refresh timeout is > 1 second.
322     if (!m_redirect || delay <= m_redirect->delay())
323         schedule(std::make_unique<ScheduledRedirect>(delay, m_frame.document()->securityOrigin(), url, true, delay <= 1));
324 }
325
326 bool NavigationScheduler::mustLockBackForwardList(Frame& targetFrame)
327 {
328     // Non-user navigation before the page has finished firing onload should not create a new back/forward item.
329     // See https://webkit.org/b/42861 for the original motivation for this.    
330     if (!ScriptController::processingUserGesture() && targetFrame.loader().documentLoader() && !targetFrame.loader().documentLoader()->wasOnloadHandled())
331         return true;
332     
333     // Navigation of a subframe during loading of an ancestor frame does not create a new back/forward item.
334     // The definition of "during load" is any time before all handlers for the load event have been run.
335     // See https://bugs.webkit.org/show_bug.cgi?id=14957 for the original motivation for this.
336     for (Frame* ancestor = targetFrame.tree().parent(); ancestor; ancestor = ancestor->tree().parent()) {
337         Document* document = ancestor->document();
338         if (!ancestor->loader().isComplete() || (document && document->processingLoadEvent()))
339             return true;
340     }
341     return false;
342 }
343
344 void NavigationScheduler::scheduleLocationChange(SecurityOrigin* securityOrigin, const String& url, const String& referrer, bool lockHistory, bool lockBackForwardList)
345 {
346     if (!shouldScheduleNavigation(url))
347         return;
348     if (url.isEmpty())
349         return;
350
351     lockBackForwardList = lockBackForwardList || mustLockBackForwardList(m_frame);
352
353     FrameLoader& loader = m_frame.loader();
354
355     // If the URL we're going to navigate to is the same as the current one, except for the
356     // fragment part, we don't need to schedule the location change.
357     URL parsedURL(ParsedURLString, url);
358     if (parsedURL.hasFragmentIdentifier() && equalIgnoringFragmentIdentifier(m_frame.document()->url(), parsedURL)) {
359         loader.changeLocation(securityOrigin, m_frame.document()->completeURL(url), referrer, lockHistory, lockBackForwardList);
360         return;
361     }
362
363     // Handle a location change of a page with no document as a special case.
364     // This may happen when a frame changes the location of another frame.
365     bool duringLoad = !loader.stateMachine()->committedFirstRealDocumentLoad();
366
367     schedule(std::make_unique<ScheduledLocationChange>(securityOrigin, url, referrer, lockHistory, lockBackForwardList, duringLoad));
368 }
369
370 void NavigationScheduler::scheduleFormSubmission(PassRefPtr<FormSubmission> submission)
371 {
372     ASSERT(m_frame.page());
373
374     // FIXME: Do we need special handling for form submissions where the URL is the same
375     // as the current one except for the fragment part? See scheduleLocationChange above.
376
377     // Handle a location change of a page with no document as a special case.
378     // This may happen when a frame changes the location of another frame.
379     bool duringLoad = !m_frame.loader().stateMachine()->committedFirstRealDocumentLoad();
380
381     // If this is a child frame and the form submission was triggered by a script, lock the back/forward list
382     // to match IE and Opera.
383     // See https://bugs.webkit.org/show_bug.cgi?id=32383 for the original motivation for this.
384     bool lockBackForwardList = mustLockBackForwardList(m_frame)
385         || (submission->state()->formSubmissionTrigger() == SubmittedByJavaScript
386             && m_frame.tree().parent() && !ScriptController::processingUserGesture());
387
388     schedule(std::make_unique<ScheduledFormSubmission>(submission, lockBackForwardList, duringLoad));
389 }
390
391 void NavigationScheduler::scheduleRefresh()
392 {
393     if (!shouldScheduleNavigation())
394         return;
395     const URL& url = m_frame.document()->url();
396     if (url.isEmpty())
397         return;
398
399     schedule(std::make_unique<ScheduledRefresh>(m_frame.document()->securityOrigin(), url.string(), m_frame.loader().outgoingReferrer()));
400 }
401
402 void NavigationScheduler::scheduleHistoryNavigation(int steps)
403 {
404     if (!shouldScheduleNavigation())
405         return;
406
407     // Invalid history navigations (such as history.forward() during a new load) have the side effect of cancelling any scheduled
408     // redirects. We also avoid the possibility of cancelling the current load by avoiding the scheduled redirection altogether.
409     BackForwardController& backForward = m_frame.page()->backForward();
410     if (steps > backForward.forwardCount() || -steps > backForward.backCount()) {
411         cancel();
412         return;
413     }
414
415     // In all other cases, schedule the history traversal to occur asynchronously.
416     schedule(std::make_unique<ScheduledHistoryNavigation>(steps));
417 }
418
419 void NavigationScheduler::timerFired(Timer<NavigationScheduler>*)
420 {
421     if (!m_frame.page())
422         return;
423     if (m_frame.page()->defersLoading()) {
424         InspectorInstrumentation::frameClearedScheduledNavigation(m_frame);
425         return;
426     }
427
428     Ref<Frame> protect(m_frame);
429
430     std::unique_ptr<ScheduledNavigation> redirect = std::move(m_redirect);
431     redirect->fire(m_frame);
432     InspectorInstrumentation::frameClearedScheduledNavigation(m_frame);
433 }
434
435 void NavigationScheduler::schedule(std::unique_ptr<ScheduledNavigation> redirect)
436 {
437     ASSERT(m_frame.page());
438
439     Ref<Frame> protect(m_frame);
440
441     // If a redirect was scheduled during a load, then stop the current load.
442     // Otherwise when the current load transitions from a provisional to a 
443     // committed state, pending redirects may be cancelled. 
444     if (redirect->wasDuringLoad()) {
445         if (DocumentLoader* provisionalDocumentLoader = m_frame.loader().provisionalDocumentLoader())
446             provisionalDocumentLoader->stopLoading();
447         m_frame.loader().stopLoading(UnloadEventPolicyUnloadAndPageHide);
448     }
449
450     cancel();
451     m_redirect = std::move(redirect);
452
453     if (!m_frame.loader().isComplete() && m_redirect->isLocationChange())
454         m_frame.loader().completed();
455
456     if (!m_frame.page())
457         return;
458
459     startTimer();
460 }
461
462 void NavigationScheduler::startTimer()
463 {
464     if (!m_redirect)
465         return;
466
467     ASSERT(m_frame.page());
468     if (m_timer.isActive())
469         return;
470     if (!m_redirect->shouldStartTimer(m_frame))
471         return;
472
473     double delay = m_redirect->delay();
474     m_timer.startOneShot(delay);
475     InspectorInstrumentation::frameScheduledNavigation(m_frame, delay);
476     m_redirect->didStartTimer(m_frame, m_timer); // m_redirect may be null on return (e.g. the client canceled the load)
477 }
478
479 void NavigationScheduler::cancel(bool newLoadInProgress)
480 {
481     if (m_timer.isActive())
482         InspectorInstrumentation::frameClearedScheduledNavigation(m_frame);
483     m_timer.stop();
484
485     if (std::unique_ptr<ScheduledNavigation> redirect = std::move(m_redirect))
486         redirect->didStopTimer(m_frame, newLoadInProgress);
487 }
488
489 } // namespace WebCore