1/*
2 * Copyright (C) 2006, 2007, 2008, 2009 Apple Inc. All rights reserved.
3 * Copyright (C) 2008, 2009 Torch Mobile Inc. All rights reserved. (http://www.torchmobile.com/)
4 * Copyright (C) 2009 Adam Barth. All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 *
10 * 1.  Redistributions of source code must retain the above copyright
11 *     notice, this list of conditions and the following disclaimer.
12 * 2.  Redistributions in binary form must reproduce the above copyright
13 *     notice, this list of conditions and the following disclaimer in the
14 *     documentation and/or other materials provided with the distribution.
15 * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
16 *     its contributors may be used to endorse or promote products derived
17 *     from this software without specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
20 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
21 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22 * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
23 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
26 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
28 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 */
30
31#ifndef NavigationScheduler_h
32#define NavigationScheduler_h
33
34#include "Event.h"
35#include "Timer.h"
36#include <wtf/Forward.h>
37#include <wtf/Noncopyable.h>
38#include <wtf/OwnPtr.h>
39#include <wtf/PassOwnPtr.h>
40#include <wtf/PassRefPtr.h>
41
42namespace WebCore {
43
44class FormState;
45class FormSubmission;
46class Frame;
47class ScheduledNavigation;
48class SecurityOrigin;
49
50struct FrameLoadRequest;
51
52class NavigationDisablerForBeforeUnload {
53    WTF_MAKE_NONCOPYABLE(NavigationDisablerForBeforeUnload);
54
55public:
56    NavigationDisablerForBeforeUnload()
57    {
58        s_navigationDisableCount++;
59    }
60    ~NavigationDisablerForBeforeUnload()
61    {
62        ASSERT(s_navigationDisableCount);
63        s_navigationDisableCount--;
64    }
65    static bool isNavigationAllowed() { return !s_navigationDisableCount; }
66
67private:
68    static unsigned s_navigationDisableCount;
69};
70
71class NavigationScheduler {
72    WTF_MAKE_NONCOPYABLE(NavigationScheduler);
73
74public:
75    NavigationScheduler(Frame*);
76    ~NavigationScheduler();
77
78    bool redirectScheduledDuringLoad();
79    bool locationChangePending();
80
81    void scheduleRedirect(double delay, const String& url);
82    void scheduleLocationChange(PassRefPtr<SecurityOrigin>, const String& url, const String& referrer, bool lockHistory = true, bool lockBackForwardList = true);
83    void scheduleFormSubmission(PassRefPtr<FormSubmission>);
84    void scheduleRefresh();
85    void scheduleHistoryNavigation(int steps);
86
87    void startTimer();
88
89    void cancel(bool newLoadInProgress = false);
90    void clear();
91
92private:
93    bool shouldScheduleNavigation() const;
94    bool shouldScheduleNavigation(const String& url) const;
95
96    void timerFired(Timer<NavigationScheduler>*);
97    void schedule(PassOwnPtr<ScheduledNavigation>);
98
99    static bool mustLockBackForwardList(Frame* targetFrame);
100
101    Frame* m_frame;
102    Timer<NavigationScheduler> m_timer;
103    OwnPtr<ScheduledNavigation> m_redirect;
104};
105
106} // namespace WebCore
107
108#endif // NavigationScheduler_h
109