REGRESSION(r214194): Safari leaves a popup window open opened during before unload
[WebKit-https.git] / Source / WebCore / loader / NavigationScheduler.h
1 /*
2  * Copyright (C) 2006-2017 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 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 #pragma once
32
33 #include "FrameLoaderTypes.h"
34 #include "Timer.h"
35 #include <wtf/Forward.h>
36
37 namespace WebCore {
38
39 class Document;
40 class FormSubmission;
41 class Frame;
42 class ScheduledNavigation;
43 class SecurityOrigin;
44 class URL;
45
46 class NavigationScheduler {
47 public:
48     explicit NavigationScheduler(Frame&);
49     ~NavigationScheduler();
50
51     bool redirectScheduledDuringLoad();
52     bool locationChangePending();
53
54     void scheduleRedirect(Document& initiatingDocument, double delay, const URL&);
55     void scheduleLocationChange(Document& initiatingDocument, SecurityOrigin&, const URL&, const String& referrer, LockHistory = LockHistory::Yes, LockBackForwardList = LockBackForwardList::Yes);
56     void scheduleFormSubmission(Ref<FormSubmission>&&);
57     void scheduleRefresh(Document& initiatingDocument);
58     void scheduleHistoryNavigation(int steps);
59     void schedulePageBlock(Document& originDocument);
60
61     void startTimer();
62
63     void cancel(bool newLoadInProgress = false);
64     void clear();
65
66 private:
67     bool shouldScheduleNavigation() const;
68     bool shouldScheduleNavigation(const URL&) const;
69
70     void timerFired();
71     void schedule(std::unique_ptr<ScheduledNavigation>);
72
73     static LockBackForwardList mustLockBackForwardList(Frame& targetFrame);
74
75     Frame& m_frame;
76     Timer m_timer;
77     std::unique_ptr<ScheduledNavigation> m_redirect;
78 };
79
80 } // namespace WebCore