d86e2261290800417a7a3e9bca2845bcf757b20f
[WebKit-https.git] / WebCore / loader / RedirectScheduler.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 "RedirectScheduler.h"
34
35 #include "BackForwardList.h"
36 #include "DocumentLoader.h"
37 #include "Event.h"
38 #include "FormState.h"
39 #include "FormSubmission.h"
40 #include "Frame.h"
41 #include "FrameLoadRequest.h"
42 #include "FrameLoader.h"
43 #include "FrameLoaderStateMachine.h"
44 #include "HistoryItem.h"
45 #include "HTMLFormElement.h"
46 #include "HTMLFrameOwnerElement.h"
47 #include "Page.h"
48 #include "UserGestureIndicator.h"
49 #include <wtf/CurrentTime.h>
50
51 namespace WebCore {
52
53 class ScheduledNavigation : public Noncopyable {
54 public:
55     ScheduledNavigation(double delay, bool lockHistory, bool lockBackForwardList, bool wasDuringLoad, bool isLocationChange)
56         : m_delay(delay)
57         , m_lockHistory(lockHistory)
58         , m_lockBackForwardList(lockBackForwardList)
59         , m_wasDuringLoad(wasDuringLoad)
60         , m_isLocationChange(isLocationChange)
61     {
62     }
63     virtual ~ScheduledNavigation() { }
64
65     virtual void fire(Frame*) = 0;
66
67     virtual bool shouldStartTimer(Frame*) { return true; }
68     virtual void didStartTimer(Frame*, Timer<RedirectScheduler>*) { }
69     virtual void didStopTimer(Frame*, bool /* newLoadInProgress */) { }
70
71     double delay() const { return m_delay; }
72     bool lockHistory() const { return m_lockHistory; }
73     bool lockBackForwardList() const { return m_lockBackForwardList; }
74     bool wasDuringLoad() const { return m_wasDuringLoad; }
75     bool isLocationChange() const { return m_isLocationChange; }
76
77 private:
78     double m_delay;
79     bool m_lockHistory;
80     bool m_lockBackForwardList;
81     bool m_wasDuringLoad;
82     bool m_isLocationChange;
83 };
84
85 class ScheduledURLNavigation : public ScheduledNavigation {
86 public:
87     ScheduledURLNavigation(double delay, const String& url, const String& referrer, bool lockHistory, bool lockBackForwardList, bool wasUserGesture, bool duringLoad, bool isLocationChange)
88         : ScheduledNavigation(delay, lockHistory, lockBackForwardList, duringLoad, isLocationChange)
89         , m_url(url)
90         , m_referrer(referrer)
91         , m_wasUserGesture(wasUserGesture)
92         , m_haveToldClient(false)
93     {
94     }
95
96     virtual void fire(Frame* frame)
97     {
98         frame->loader()->changeLocation(KURL(ParsedURLString, m_url), m_referrer, lockHistory(), lockBackForwardList(), m_wasUserGesture, false);
99     }
100
101     virtual void didStartTimer(Frame* frame, Timer<RedirectScheduler>* timer)
102     {
103         if (m_haveToldClient)
104             return;
105         m_haveToldClient = true;
106         frame->loader()->clientRedirected(KURL(ParsedURLString, m_url), delay(), currentTime() + timer->nextFireInterval(), lockBackForwardList());
107     }
108
109     virtual void didStopTimer(Frame* frame, bool newLoadInProgress)
110     {
111         if (!m_haveToldClient)
112             return;
113         frame->loader()->clientRedirectCancelledOrFinished(newLoadInProgress);
114     }
115
116     String url() const { return m_url; }
117     String referrer() const { return m_referrer; }
118     bool wasUserGesture() const { return m_wasUserGesture; }
119
120 private:
121     String m_url;
122     String m_referrer;
123     bool m_wasUserGesture;
124     bool m_haveToldClient;
125 };
126
127 class ScheduledRedirect : public ScheduledURLNavigation {
128 public:
129     ScheduledRedirect(double delay, const String& url, bool lockHistory, bool lockBackForwardList, bool wasUserGesture)
130         : ScheduledURLNavigation(delay, url, String(), lockHistory, lockBackForwardList, wasUserGesture, false, false) { }
131
132     virtual bool shouldStartTimer(Frame* frame) { return frame->loader()->allAncestorsAreComplete(); }
133 };
134
135 class ScheduledLocationChange : public ScheduledURLNavigation {
136 public:
137     ScheduledLocationChange(const String& url, const String& referrer, bool lockHistory, bool lockBackForwardList, bool wasUserGesture, bool duringLoad)
138         : ScheduledURLNavigation(0.0, url, referrer, lockHistory, lockBackForwardList, wasUserGesture, duringLoad, true) { }
139 };
140
141 class ScheduledRefresh : public ScheduledURLNavigation {
142 public:
143     ScheduledRefresh(const String& url, const String& referrer, bool wasUserGesture)
144         : ScheduledURLNavigation(0.0, url, referrer, true, true, wasUserGesture, false, true) { }
145
146     virtual void fire(Frame* frame)
147     {
148         frame->loader()->changeLocation(KURL(ParsedURLString, url()), referrer(), lockHistory(), lockBackForwardList(), wasUserGesture(), true);
149     }
150 };
151
152 class ScheduledHistoryNavigation : public ScheduledNavigation {
153 public:
154     explicit ScheduledHistoryNavigation(int historySteps) : ScheduledNavigation(0, false, false, false, true), m_historySteps(historySteps) { }
155
156     virtual void fire(Frame* frame)
157     {
158         FrameLoader* loader = frame->loader();
159         if (!m_historySteps) {
160             // Special case for go(0) from a frame -> reload only the frame
161             loader->urlSelected(loader->url(), "", 0, lockHistory(), lockBackForwardList(), false, SendReferrer);
162             return;
163         }
164         // go(i!=0) from a frame navigates into the history of the frame only,
165         // in both IE and NS (but not in Mozilla). We can't easily do that.
166         frame->page()->goBackOrForward(m_historySteps);
167     }
168
169 private:
170     int m_historySteps;
171 };
172
173 class ScheduledFormSubmission : public ScheduledNavigation {
174 public:
175     ScheduledFormSubmission(PassRefPtr<FormSubmission> submission, bool lockBackForwardList, bool duringLoad)
176         : ScheduledNavigation(0, submission->lockHistory(), lockBackForwardList, duringLoad, true)
177         , m_submission(submission)
178         , m_wasProcessingUserGesture(UserGestureIndicator::processingUserGesture())
179     {
180         ASSERT(m_submission->state());
181     }
182
183     virtual void fire(Frame* frame)
184     {
185         UserGestureIndicator gestureIndicator(m_wasProcessingUserGesture ? DefinitelyProcessingUserGesture : DefinitelyNotProcessingUserGesture);
186
187         // The submitForm function will find a target frame before using the redirection timer.
188         // Now that the timer has fired, we need to repeat the security check which normally is done when
189         // selecting a target, in case conditions have changed. Other code paths avoid this by targeting
190         // without leaving a time window. If we fail the check just silently drop the form submission.
191         if (!m_submission->state()->sourceFrame()->loader()->shouldAllowNavigation(frame))
192             return;
193         FrameLoadRequest frameRequest;
194         m_submission->populateFrameLoadRequest(frameRequest);
195         frame->loader()->loadFrameRequest(frameRequest, lockHistory(), lockBackForwardList(), m_submission->event(), m_submission->state(), SendReferrer);
196     }
197
198     // FIXME: Implement didStartTimer? It would make sense to report form
199     // submissions as client redirects too. But we didn't do that in the past
200     // when form submission used a separate delay mechanism, so doing it will
201     // be a behavior change.
202
203 private:
204     RefPtr<FormSubmission> m_submission;
205     bool m_wasProcessingUserGesture;
206 };
207
208 RedirectScheduler::RedirectScheduler(Frame* frame)
209     : m_frame(frame)
210     , m_timer(this, &RedirectScheduler::timerFired)
211 {
212 }
213
214 RedirectScheduler::~RedirectScheduler()
215 {
216 }
217
218 bool RedirectScheduler::redirectScheduledDuringLoad()
219 {
220     return m_redirect && m_redirect->wasDuringLoad();
221 }
222
223 bool RedirectScheduler::locationChangePending()
224 {
225     return m_redirect && m_redirect->isLocationChange();
226 }
227
228 void RedirectScheduler::clear()
229 {
230     m_timer.stop();
231     m_redirect.clear();
232 }
233
234 void RedirectScheduler::scheduleRedirect(double delay, const String& url)
235 {
236     if (!m_frame->page())
237         return;
238     if (delay < 0 || delay > INT_MAX / 1000)
239         return;
240     if (url.isEmpty())
241         return;
242
243     // We want a new back forward list item if the refresh timeout is > 1 second.
244     if (!m_redirect || delay <= m_redirect->delay())
245         schedule(new ScheduledRedirect(delay, url, true, delay <= 1, false));
246 }
247
248 bool RedirectScheduler::mustLockBackForwardList(Frame* targetFrame, bool mustLockIfDuringLoad)
249 {
250     // Non-user navigation before the page has loaded should not create a new back/forward item.
251     // See https://webkit.org/b/42861 for the original motivation for this.    
252     if (mustLockIfDuringLoad && targetFrame->loader()->documentLoader() && targetFrame->loader()->documentLoader()->isLoadingInAPISense())
253         return true;
254     
255     // Navigation of a subframe during loading of an ancestor frame does not create a new back/forward item.
256     // The definition of "during load" is any time before all handlers for the load event have been run.
257     // See https://bugs.webkit.org/show_bug.cgi?id=14957 for the original motivation for this.
258     for (Frame* ancestor = targetFrame->tree()->parent(); ancestor; ancestor = ancestor->tree()->parent()) {
259         Document* document = ancestor->document();
260         if (!ancestor->loader()->isComplete() || (document && document->processingLoadEvent()))
261             return true;
262     }
263     return false;
264 }
265
266 void RedirectScheduler::scheduleLocationChange(const String& url, const String& referrer, bool lockHistory, bool lockBackForwardList, bool wasUserGesture)
267 {
268     if (!m_frame->page())
269         return;
270     if (url.isEmpty())
271         return;
272
273     lockBackForwardList = lockBackForwardList || mustLockBackForwardList(m_frame, !wasUserGesture);
274
275     FrameLoader* loader = m_frame->loader();
276     
277     // If the URL we're going to navigate to is the same as the current one, except for the
278     // fragment part, we don't need to schedule the location change.
279     KURL parsedURL(ParsedURLString, url);
280     if (parsedURL.hasFragmentIdentifier() && equalIgnoringFragmentIdentifier(loader->url(), parsedURL)) {
281         loader->changeLocation(loader->completeURL(url), referrer, lockHistory, lockBackForwardList, wasUserGesture);
282         return;
283     }
284
285     // Handle a location change of a page with no document as a special case.
286     // This may happen when a frame changes the location of another frame.
287     bool duringLoad = !loader->stateMachine()->committedFirstRealDocumentLoad();
288
289     schedule(new ScheduledLocationChange(url, referrer, lockHistory, lockBackForwardList, wasUserGesture, duringLoad));
290 }
291
292 void RedirectScheduler::scheduleFormSubmission(PassRefPtr<FormSubmission> submission)
293 {
294     ASSERT(m_frame->page());
295
296     // FIXME: Do we need special handling for form submissions where the URL is the same
297     // as the current one except for the fragment part? See scheduleLocationChange above.
298
299     // Handle a location change of a page with no document as a special case.
300     // This may happen when a frame changes the location of another frame.
301     bool duringLoad = !m_frame->loader()->stateMachine()->committedFirstRealDocumentLoad();
302
303     // If this is a child frame and the form submission was triggered by a script, lock the back/forward list
304     // to match IE and Opera.
305     // See https://bugs.webkit.org/show_bug.cgi?id=32383 for the original motivation for this.
306
307     bool lockBackForwardList = mustLockBackForwardList(m_frame, false) || (submission->state()->formSubmissionTrigger() == SubmittedByJavaScript && m_frame->tree()->parent());
308
309     schedule(new ScheduledFormSubmission(submission, lockBackForwardList, duringLoad));
310 }
311
312 void RedirectScheduler::scheduleRefresh(bool wasUserGesture)
313 {
314     if (!m_frame->page())
315         return;
316     const KURL& url = m_frame->loader()->url();
317     if (url.isEmpty())
318         return;
319
320     schedule(new ScheduledRefresh(url.string(), m_frame->loader()->outgoingReferrer(), wasUserGesture));
321 }
322
323 void RedirectScheduler::scheduleHistoryNavigation(int steps)
324 {
325     if (!m_frame->page())
326         return;
327
328     // Invalid history navigations (such as history.forward() during a new load) have the side effect of cancelling any scheduled
329     // redirects. We also avoid the possibility of cancelling the current load by avoiding the scheduled redirection altogether.
330     HistoryItem* specifiedEntry = m_frame->page()->backForwardList()->itemAtIndex(steps);
331     if (!specifiedEntry) {
332         cancel();
333         return;
334     }
335     
336 #if !ENABLE(HISTORY_ALWAYS_ASYNC)
337     // If the specified entry and the current entry have the same document, this is either a state object traversal or a fragment 
338     // traversal (or both) and should be performed synchronously.
339     HistoryItem* currentEntry = m_frame->loader()->history()->currentItem();
340     if (currentEntry != specifiedEntry && currentEntry->documentSequenceNumber() == specifiedEntry->documentSequenceNumber()) {
341         m_frame->loader()->history()->goToItem(specifiedEntry, FrameLoadTypeIndexedBackForward);
342         return;
343     }
344 #endif
345     
346     // In all other cases, schedule the history traversal to occur asynchronously.
347     schedule(new ScheduledHistoryNavigation(steps));
348 }
349
350 void RedirectScheduler::timerFired(Timer<RedirectScheduler>*)
351 {
352     if (!m_frame->page())
353         return;
354     if (m_frame->page()->defersLoading())
355         return;
356
357     OwnPtr<ScheduledNavigation> redirect(m_redirect.release());
358     redirect->fire(m_frame);
359 }
360
361 void RedirectScheduler::schedule(PassOwnPtr<ScheduledNavigation> redirect)
362 {
363     ASSERT(m_frame->page());
364
365     // If a redirect was scheduled during a load, then stop the current load.
366     // Otherwise when the current load transitions from a provisional to a 
367     // committed state, pending redirects may be cancelled. 
368     if (redirect->wasDuringLoad()) {
369         if (DocumentLoader* provisionalDocumentLoader = m_frame->loader()->provisionalDocumentLoader())
370             provisionalDocumentLoader->stopLoading();
371         m_frame->loader()->stopLoading(UnloadEventPolicyUnloadAndPageHide);   
372     }
373
374     cancel();
375     m_redirect = redirect;
376
377     if (!m_frame->loader()->isComplete() && m_redirect->isLocationChange())
378         m_frame->loader()->completed();
379
380     startTimer();
381 }
382
383 void RedirectScheduler::startTimer()
384 {
385     if (!m_redirect)
386         return;
387
388     ASSERT(m_frame->page());
389     if (m_timer.isActive())
390         return;
391     if (!m_redirect->shouldStartTimer(m_frame))
392         return;
393
394     m_timer.startOneShot(m_redirect->delay());
395     m_redirect->didStartTimer(m_frame, &m_timer);
396 }
397
398 void RedirectScheduler::cancel(bool newLoadInProgress)
399 {
400     m_timer.stop();
401
402     OwnPtr<ScheduledNavigation> redirect(m_redirect.release());
403     if (redirect)
404         redirect->didStopTimer(m_frame, newLoadInProgress);
405 }
406
407 } // namespace WebCore