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