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/CompletionHandler.h>
36#include <wtf/Forward.h>
37
38namespace WebCore {
39
40class Document;
41class FormSubmission;
42class Frame;
43class ScheduledNavigation;
44class SecurityOrigin;
45
46enum class NewLoadInProgress : bool { No, Yes };
47
48class NavigationScheduler {
49public:
50 explicit NavigationScheduler(Frame&);
51 ~NavigationScheduler();
52
53 bool redirectScheduledDuringLoad();
54 bool locationChangePending();
55
56 void scheduleRedirect(Document& initiatingDocument, double delay, const URL&);
57 void scheduleLocationChange(Document& initiatingDocument, SecurityOrigin&, const URL&, const String& referrer, LockHistory = LockHistory::Yes, LockBackForwardList = LockBackForwardList::Yes, CompletionHandler<void()>&& = [] { });
58 void scheduleFormSubmission(Ref<FormSubmission>&&);
59 void scheduleRefresh(Document& initiatingDocument);
60 void scheduleHistoryNavigation(int steps);
61 void schedulePageBlock(Document& originDocument);
62
63 void startTimer();
64
65 void cancel(NewLoadInProgress = NewLoadInProgress::No);
66 void clear();
67
68private:
69 bool shouldScheduleNavigation() const;
70 bool shouldScheduleNavigation(const URL&) const;
71
72 void timerFired();
73 void schedule(std::unique_ptr<ScheduledNavigation>);
74
75 static LockBackForwardList mustLockBackForwardList(Frame& targetFrame);
76
77 Frame& m_frame;
78 Timer m_timer;
79 std::unique_ptr<ScheduledNavigation> m_redirect;
80};
81
82} // namespace WebCore
83