Source/WebCore:
[WebKit-https.git] / Source / WebCore / history / CachedFrame.cpp
1 /*
2  * Copyright (C) 2009 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 "AnimationController.h"
30 #include "CachedFramePlatformData.h"
31 #include "DOMWindow.h"
32 #include "Document.h"
33 #include "DocumentLoader.h"
34 #include "EventNames.h"
35 #include "ExceptionCode.h"
36 #include "FrameLoader.h"
37 #include "FrameLoaderClient.h"
38 #include "FrameView.h"
39 #include "HistoryController.h"
40 #include "HistoryItem.h"
41 #include "Logging.h"
42 #include "MainFrame.h"
43 #include "Page.h"
44 #include "PageCache.h"
45 #include "PageTransitionEvent.h"
46 #include "SVGDocumentExtensions.h"
47 #include "ScriptController.h"
48 #include "SerializedScriptValue.h"
49 #include <wtf/RefCountedLeakCounter.h>
50 #include <wtf/text/CString.h>
51
52 #if PLATFORM(IOS) || ENABLE(TOUCH_EVENTS)
53 #include "Chrome.h"
54 #include "ChromeClient.h"
55 #endif
56
57 namespace WebCore {
58
59 DEFINE_DEBUG_ONLY_GLOBAL(WTF::RefCountedLeakCounter, cachedFrameCounter, ("CachedFrame"));
60
61 CachedFrameBase::CachedFrameBase(Frame& frame)
62     : m_document(frame.document())
63     , m_documentLoader(frame.loader().documentLoader())
64     , m_view(frame.view())
65     , m_url(frame.document()->url())
66     , m_isMainFrame(!frame.tree().parent())
67     , m_isComposited(frame.view()->hasCompositedContent())
68 {
69 }
70
71 CachedFrameBase::~CachedFrameBase()
72 {
73 #ifndef NDEBUG
74     cachedFrameCounter.decrement();
75 #endif
76     // CachedFrames should always have had destroy() called by their parent CachedPage
77     ASSERT(!m_document);
78 }
79
80 void CachedFrameBase::restore()
81 {
82     ASSERT(m_document->view() == m_view);
83
84     if (m_isMainFrame)
85         m_view->setParentVisible(true);
86
87     Frame& frame = m_view->frame();
88     m_cachedFrameScriptData->restore(frame);
89
90     if (m_document->svgExtensions())
91         m_document->accessSVGExtensions().unpauseAnimations();
92
93     frame.animation().resumeAnimationsForDocument(m_document.get());
94
95     m_document->resume(ActiveDOMObject::PageCache);
96
97     // It is necessary to update any platform script objects after restoring the
98     // cached page.
99     frame.script().updatePlatformScriptObjects();
100
101     if (m_isComposited)
102         frame.view()->restoreBackingStores();
103
104     frame.loader().client().didRestoreFromPageCache();
105
106     // Reconstruct the FrameTree. And open the child CachedFrames in their respective FrameLoaders.
107     for (unsigned i = 0; i < m_childFrames.size(); ++i) {
108         frame.tree().appendChild(&m_childFrames[i]->view()->frame());
109         m_childFrames[i]->open();
110     }
111
112 #if PLATFORM(IOS)
113     if (m_isMainFrame) {
114         frame.loader().client().didRestoreFrameHierarchyForCachedFrame();
115
116         if (DOMWindow* domWindow = m_document->domWindow()) {
117             // FIXME: Add SCROLL_LISTENER to the list of event types on Document, and use m_document->hasListenerType(). See <rdar://problem/9615482>.
118             // FIXME: Can use Document::hasListenerType() now.
119             if (domWindow->scrollEventListenerCount() && frame.page())
120                 frame.page()->chrome().client().setNeedsScrollNotifications(&frame, true);
121         }
122     }
123 #endif
124
125     // FIXME: update Page Visibility state here.
126     // https://bugs.webkit.org/show_bug.cgi?id=116770
127     m_document->enqueuePageshowEvent(PageshowEventPersisted);
128
129     HistoryItem* historyItem = frame.loader().history().currentItem();
130     if (historyItem && historyItem->stateObject())
131         m_document->enqueuePopstateEvent(historyItem->stateObject());
132
133 #if ENABLE(TOUCH_EVENTS) && !PLATFORM(IOS)
134     if (m_document->hasTouchEventHandlers())
135         m_document->page()->chrome().client().needTouchEvents(true);
136 #endif
137
138 }
139
140 CachedFrame::CachedFrame(Frame& frame)
141     : CachedFrameBase(frame)
142 {
143 #ifndef NDEBUG
144     cachedFrameCounter.increment();
145 #endif
146     ASSERT(m_document);
147     ASSERT(m_documentLoader);
148     ASSERT(m_view);
149
150     // Custom scrollbar renderers will get reattached when the document comes out of the page cache
151     m_view->detachCustomScrollbars();
152
153     ASSERT(m_document->inPageCache());
154
155     // Create the CachedFrames for all Frames in the FrameTree.
156     for (Frame* child = frame.tree().firstChild(); child; child = child->tree().nextSibling())
157         m_childFrames.append(std::make_unique<CachedFrame>(*child));
158
159     // Active DOM objects must be suspended before we cache the frame script data.
160     m_document->suspend(ActiveDOMObject::PageCache);
161
162     m_cachedFrameScriptData = std::make_unique<ScriptCachedFrameData>(frame);
163
164     m_document->domWindow()->suspendForDocumentSuspension();
165
166     frame.loader().client().savePlatformDataToCachedFrame(this);
167
168     if (m_isComposited && PageCache::singleton().shouldClearBackingStores())
169         frame.view()->clearBackingStores();
170
171     // documentWillSuspendForPageCache() can set up a layout timer on the FrameView, so clear timers after that.
172     frame.clearTimers();
173
174     // Deconstruct the FrameTree, to restore it later.
175     // We do this for two reasons:
176     // 1 - We reuse the main frame, so when it navigates to a new page load it needs to start with a blank FrameTree.
177     // 2 - It's much easier to destroy a CachedFrame while it resides in the PageCache if it is disconnected from its parent.
178     for (unsigned i = 0; i < m_childFrames.size(); ++i)
179         frame.tree().removeChild(&m_childFrames[i]->view()->frame());
180
181     if (!m_isMainFrame)
182         frame.page()->decrementSubframeCount();
183
184     frame.loader().client().didSaveToPageCache();
185
186 #ifndef NDEBUG
187     if (m_isMainFrame)
188         LOG(PageCache, "Finished creating CachedFrame for main frame url '%s' and DocumentLoader %p\n", m_url.string().utf8().data(), m_documentLoader.get());
189     else
190         LOG(PageCache, "Finished creating CachedFrame for child frame with url '%s' and DocumentLoader %p\n", m_url.string().utf8().data(), m_documentLoader.get());
191 #endif
192
193 #if PLATFORM(IOS)
194     if (m_isMainFrame) {
195         if (DOMWindow* domWindow = m_document->domWindow()) {
196             if (domWindow->scrollEventListenerCount() && frame.page())
197                 frame.page()->chrome().client().setNeedsScrollNotifications(&frame, false);
198         }
199     }
200 #endif
201
202     ASSERT_WITH_SECURITY_IMPLICATION(!m_documentLoader->isLoading());
203 }
204
205 void CachedFrame::open()
206 {
207     ASSERT(m_view);
208     if (!m_isMainFrame)
209         m_view->frame().page()->incrementSubframeCount();
210
211     m_view->frame().loader().open(*this);
212 }
213
214 void CachedFrame::clear()
215 {
216     if (!m_document)
217         return;
218
219     // clear() should only be called for Frames representing documents that are no longer in the page cache.
220     // This means the CachedFrame has been:
221     // 1 - Successfully restore()'d by going back/forward.
222     // 2 - destroy()'ed because the PageCache is pruning or the WebView was closed.
223     ASSERT(!m_document->inPageCache());
224     ASSERT(m_view);
225     ASSERT(!m_document->frame() || m_document->frame() == &m_view->frame());
226
227     for (int i = m_childFrames.size() - 1; i >= 0; --i)
228         m_childFrames[i]->clear();
229
230     m_document = nullptr;
231     m_view = nullptr;
232     m_url = URL();
233
234     m_cachedFramePlatformData = nullptr;
235     m_cachedFrameScriptData = nullptr;
236 }
237
238 void CachedFrame::destroy()
239 {
240     if (!m_document)
241         return;
242     
243     // Only CachedFrames that are still in the PageCache should be destroyed in this manner
244     ASSERT(m_document->inPageCache());
245     ASSERT(m_view);
246     ASSERT(m_document->frame() == &m_view->frame());
247
248     m_document->domWindow()->willDestroyCachedFrame();
249
250     if (!m_isMainFrame) {
251         m_view->frame().detachFromPage();
252         m_view->frame().loader().detachViewsAndDocumentLoader();
253     }
254     
255     for (int i = m_childFrames.size() - 1; i >= 0; --i)
256         m_childFrames[i]->destroy();
257
258     if (m_cachedFramePlatformData)
259         m_cachedFramePlatformData->clear();
260
261     Frame::clearTimers(m_view.get(), m_document.get());
262
263     // FIXME: Why do we need to call removeAllEventListeners here? When the document is in page cache, this method won't work
264     // fully anyway, because the document won't be able to access its DOMWindow object (due to being frameless).
265     m_document->removeAllEventListeners();
266
267     m_document->setInPageCache(false);
268     m_document->prepareForDestruction();
269
270     clear();
271 }
272
273 void CachedFrame::setCachedFramePlatformData(std::unique_ptr<CachedFramePlatformData> data)
274 {
275     m_cachedFramePlatformData = WTFMove(data);
276 }
277
278 CachedFramePlatformData* CachedFrame::cachedFramePlatformData()
279 {
280     return m_cachedFramePlatformData.get();
281 }
282
283 int CachedFrame::descendantFrameCount() const
284 {
285     int count = m_childFrames.size();
286     for (size_t i = 0; i < m_childFrames.size(); ++i)
287         count += m_childFrames[i]->descendantFrameCount();
288     
289     return count;
290 }
291
292 } // namespace WebCore