Frame.h doesn't need to include FrameLoader.h, IntRect.h, and NavigationScheduler.h
[WebKit-https.git] / Source / WebCore / history / CachedPage.cpp
1 /*
2  * Copyright (C) 2006, 2007, 2008, 2014 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #include "config.h"
27 #include "CachedPage.h"
28
29 #include "Document.h"
30 #include "Element.h"
31 #include "FocusController.h"
32 #include "FrameLoader.h"
33 #include "FrameView.h"
34 #include "HistoryController.h"
35 #include "HistoryItem.h"
36 #include "MainFrame.h"
37 #include "NoEventDispatchAssertion.h"
38 #include "Node.h"
39 #include "Page.h"
40 #include "PageTransitionEvent.h"
41 #include "Settings.h"
42 #include "VisitedLinkState.h"
43 #include <wtf/CurrentTime.h>
44 #include <wtf/RefCountedLeakCounter.h>
45 #include <wtf/StdLibExtras.h>
46
47 #if PLATFORM(IOS)
48 #include "FrameSelection.h"
49 #endif
50
51 using namespace JSC;
52
53 namespace WebCore {
54
55 DEFINE_DEBUG_ONLY_GLOBAL(WTF::RefCountedLeakCounter, cachedPageCounter, ("CachedPage"));
56
57 CachedPage::CachedPage(Page& page)
58     : m_page(page)
59     , m_expirationTime(monotonicallyIncreasingTime() + page.settings().backForwardCacheExpirationInterval())
60     , m_cachedMainFrame(std::make_unique<CachedFrame>(page.mainFrame()))
61 {
62 #ifndef NDEBUG
63     cachedPageCounter.increment();
64 #endif
65 }
66
67 CachedPage::~CachedPage()
68 {
69 #ifndef NDEBUG
70     cachedPageCounter.decrement();
71 #endif
72
73     if (m_cachedMainFrame)
74         m_cachedMainFrame->destroy();
75 }
76
77 static void firePageShowAndPopStateEvents(Page& page)
78 {
79     // Dispatching JavaScript events can cause frame destruction.
80     auto& mainFrame = page.mainFrame();
81     Vector<Ref<Frame>> childFrames;
82     for (auto* child = mainFrame.tree().traverseNextInPostOrder(CanWrap::Yes); child; child = child->tree().traverseNextInPostOrder(CanWrap::No))
83         childFrames.append(*child);
84
85     for (auto& child : childFrames) {
86         if (!child->tree().isDescendantOf(&mainFrame))
87             continue;
88         auto* document = child->document();
89         if (!document)
90             continue;
91
92         // FIXME: Update Page Visibility state here.
93         // https://bugs.webkit.org/show_bug.cgi?id=116770
94         document->dispatchPageshowEvent(PageshowEventPersisted);
95
96         auto* historyItem = child->loader().history().currentItem();
97         if (historyItem && historyItem->stateObject())
98             document->dispatchPopstateEvent(historyItem->stateObject());
99     }
100 }
101
102 void CachedPage::restore(Page& page)
103 {
104     ASSERT(m_cachedMainFrame);
105     ASSERT(m_cachedMainFrame->view()->frame().isMainFrame());
106     ASSERT(!page.subframeCount());
107
108     {
109         // Do not dispatch DOM events as their JavaScript listeners could cause the page to be put
110         // into the page cache before we have finished restoring it from the page cache.
111         NoEventDispatchAssertion noEventDispatchAssertion;
112
113         m_cachedMainFrame->open();
114     }
115     
116     // Restore the focus appearance for the focused element.
117     // FIXME: Right now we don't support pages w/ frames in the b/f cache.  This may need to be tweaked when we add support for that.
118     Document* focusedDocument = page.focusController().focusedOrMainFrame().document();
119     if (Element* element = focusedDocument->focusedElement()) {
120 #if PLATFORM(IOS)
121         // We don't want focused nodes changing scroll position when restoring from the cache
122         // as it can cause ugly jumps before we manage to restore the cached position.
123         page.mainFrame().selection().suppressScrolling();
124
125         bool hadProhibitsScrolling = false;
126         FrameView* frameView = page.mainFrame().view();
127         if (frameView) {
128             hadProhibitsScrolling = frameView->prohibitsScrolling();
129             frameView->setProhibitsScrolling(true);
130         }
131 #endif
132         element->updateFocusAppearance(SelectionRestorationMode::Restore);
133 #if PLATFORM(IOS)
134         if (frameView)
135             frameView->setProhibitsScrolling(hadProhibitsScrolling);
136         page.mainFrame().selection().restoreScrolling();
137 #endif
138     }
139
140     if (m_needsDeviceOrPageScaleChanged)
141         page.mainFrame().deviceOrPageScaleFactorChanged();
142
143     page.setNeedsRecalcStyleInAllFrames();
144
145 #if ENABLE(VIDEO_TRACK)
146     if (m_needsCaptionPreferencesChanged)
147         page.captionPreferencesChanged();
148 #endif
149
150     if (m_needsUpdateContentsSize) {
151         if (FrameView* frameView = page.mainFrame().view())
152             frameView->updateContentsSize();
153     }
154
155     firePageShowAndPopStateEvents(page);
156
157     clear();
158 }
159
160 void CachedPage::clear()
161 {
162     ASSERT(m_cachedMainFrame);
163     m_cachedMainFrame->clear();
164     m_cachedMainFrame = nullptr;
165 #if ENABLE(VIDEO_TRACK)
166     m_needsCaptionPreferencesChanged = false;
167 #endif
168     m_needsDeviceOrPageScaleChanged = false;
169     m_needsUpdateContentsSize = false;
170 }
171
172 bool CachedPage::hasExpired() const
173 {
174     return monotonicallyIncreasingTime() > m_expirationTime;
175 }
176
177 } // namespace WebCore