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