d21f95828f2f4f6dd9e4d5654688870308e4a4a9
[WebKit.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 COMPUTER, 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 COMPUTER, 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 "CachedFramePlatformData.h"
30 #include "DocumentLoader.h"
31 #include "ExceptionCode.h"
32 #include "EventNames.h"
33 #include "Frame.h"
34 #include "FrameLoaderClient.h"
35 #include "FrameView.h"
36 #include "HistoryItem.h"
37 #include "Logging.h"
38 #include "PageTransitionEvent.h"
39 #include <wtf/text/CString.h>
40 #include <wtf/RefCountedLeakCounter.h>
41
42 #if ENABLE(SVG)
43 #include "SVGDocumentExtensions.h"
44 #endif
45
46 #if ENABLE(TOUCH_EVENTS)
47 #include "Chrome.h"
48 #include "ChromeClient.h"
49 #include "Page.h"
50 #endif
51
52 namespace WebCore {
53
54 #ifndef NDEBUG
55 static WTF::RefCountedLeakCounter& cachedFrameCounter()
56 {
57     DEFINE_STATIC_LOCAL(WTF::RefCountedLeakCounter, counter, ("CachedFrame"));
58     return counter;
59 }
60 #endif
61
62 CachedFrameBase::CachedFrameBase(Frame* frame)
63     : m_document(frame->document())
64     , m_documentLoader(frame->loader()->documentLoader())
65     , m_view(frame->view())
66     , m_mousePressNode(frame->eventHandler()->mousePressNode())
67     , m_url(frame->loader()->url())
68     , m_isMainFrame(!frame->tree()->parent())
69 {
70 }
71
72 CachedFrameBase::~CachedFrameBase()
73 {
74 #ifndef NDEBUG
75     cachedFrameCounter().decrement();
76 #endif
77     // CachedFrames should always have had destroy() called by their parent CachedPage
78     ASSERT(!m_document);
79 }
80
81 void CachedFrameBase::restore()
82 {
83     ASSERT(m_document->view() == m_view);
84     
85     Frame* frame = m_view->frame();
86     m_cachedFrameScriptData->restore(frame);
87
88 #if ENABLE(SVG)
89     if (m_document->svgExtensions())
90         m_document->accessSVGExtensions()->unpauseAnimations();
91 #endif
92
93     frame->animation()->resumeAnimationsForDocument(m_document.get());
94     frame->eventHandler()->setMousePressNode(m_mousePressNode.get());
95     m_document->resumeActiveDOMObjects();
96
97     // It is necessary to update any platform script objects after restoring the
98     // cached page.
99     frame->script()->updatePlatformScriptObjects();
100
101     frame->loader()->client()->didRestoreFromPageCache();
102
103     // Reconstruct the FrameTree
104     for (unsigned i = 0; i < m_childFrames.size(); ++i)
105         frame->tree()->appendChild(m_childFrames[i]->view()->frame());
106
107     // Open the child CachedFrames in their respective FrameLoaders.
108     for (unsigned i = 0; i < m_childFrames.size(); ++i)
109         m_childFrames[i]->open();
110
111     m_document->enqueuePageshowEvent(PageshowEventPersisted);
112     
113     HistoryItem* historyItem = frame->loader()->history()->currentItem();
114     m_document->enqueuePopstateEvent(historyItem && historyItem->stateObject() ? historyItem->stateObject() : SerializedScriptValue::nullValue());
115     
116 #if ENABLE(TOUCH_EVENTS)
117     if (m_document->hasListenerType(Document::TOUCH_LISTENER))
118         m_document->page()->chrome()->client()->needTouchEvents(true);
119 #endif
120
121     m_document->documentDidBecomeActive();
122 }
123
124 CachedFrame::CachedFrame(Frame* frame)
125     : CachedFrameBase(frame)
126 {
127 #ifndef NDEBUG
128     cachedFrameCounter().increment();
129 #endif
130     ASSERT(m_document);
131     ASSERT(m_documentLoader);
132     ASSERT(m_view);
133
134     // Active DOM objects must be suspended before we cached the frame script data
135     m_document->suspendActiveDOMObjects(ActiveDOMObject::DocumentWillBecomeInactive);
136     m_cachedFrameScriptData = adoptPtr(new ScriptCachedFrameData(frame));
137     
138     // Custom scrollbar renderers will get reattached when the document comes out of the page cache
139     m_view->detachCustomScrollbars();
140
141     m_document->documentWillBecomeInactive();
142     frame->clearTimers();
143     m_document->setInPageCache(true);
144     frame->loader()->stopLoading(UnloadEventPolicyUnloadAndPageHide);
145     
146     frame->loader()->client()->savePlatformDataToCachedFrame(this);
147
148     // Create the CachedFrames for all Frames in the FrameTree.
149     for (Frame* child = frame->tree()->firstChild(); child; child = child->tree()->nextSibling())
150         m_childFrames.append(CachedFrame::create(child));
151
152     // Deconstruct the FrameTree, to restore it later.
153     // We do this for two reasons:
154     // 1 - We reuse the main frame, so when it navigates to a new page load it needs to start with a blank FrameTree.
155     // 2 - It's much easier to destroy a CachedFrame while it resides in the PageCache if it is disconnected from its parent.
156     for (unsigned i = 0; i < m_childFrames.size(); ++i)
157         frame->tree()->removeChild(m_childFrames[i]->view()->frame());
158
159     if (!m_isMainFrame)
160         frame->page()->decrementFrameCount();
161
162     frame->loader()->client()->didSaveToPageCache();
163
164 #ifndef NDEBUG
165     if (m_isMainFrame)
166         LOG(PageCache, "Finished creating CachedFrame for main frame url '%s' and DocumentLoader %p\n", m_url.string().utf8().data(), m_documentLoader.get());
167     else
168         LOG(PageCache, "Finished creating CachedFrame for child frame with url '%s' and DocumentLoader %p\n", m_url.string().utf8().data(), m_documentLoader.get());
169 #endif
170
171 #if ENABLE(TOUCH_EVENTS)
172     if (m_document->hasListenerType(Document::TOUCH_LISTENER))
173         m_document->page()->chrome()->client()->needTouchEvents(false);
174 #endif
175 }
176
177 void CachedFrame::open()
178 {
179     ASSERT(m_view);
180     m_view->frame()->loader()->open(*this);
181
182     if (!m_isMainFrame)
183         m_view->frame()->page()->incrementFrameCount();
184 }
185
186 void CachedFrame::clear()
187 {
188     if (!m_document)
189         return;
190
191     // clear() should only be called for Frames representing documents that are no longer in the page cache.
192     // This means the CachedFrame has been:
193     // 1 - Successfully restore()'d by going back/forward.
194     // 2 - destroy()'ed because the PageCache is pruning or the WebView was closed.
195     ASSERT(!m_document->inPageCache());
196     ASSERT(m_view);
197     ASSERT(m_document->frame() == m_view->frame());
198
199     for (int i = m_childFrames.size() - 1; i >= 0; --i)
200         m_childFrames[i]->clear();
201
202     m_document = 0;
203     m_view = 0;
204     m_mousePressNode = 0;
205     m_url = KURL();
206
207     m_cachedFramePlatformData.clear();
208     m_cachedFrameScriptData.clear();
209 }
210
211 void CachedFrame::destroy()
212 {
213     if (!m_document)
214         return;
215     
216     // Only CachedFrames that are still in the PageCache should be destroyed in this manner
217     ASSERT(m_document->inPageCache());
218     ASSERT(m_view);
219     ASSERT(m_document->frame() == m_view->frame());
220
221     if (!m_isMainFrame) {
222         m_view->frame()->detachFromPage();
223         m_view->frame()->loader()->detachViewsAndDocumentLoader();
224     }
225     
226     for (int i = m_childFrames.size() - 1; i >= 0; --i)
227         m_childFrames[i]->destroy();
228
229     if (m_cachedFramePlatformData)
230         m_cachedFramePlatformData->clear();
231
232     Frame::clearTimers(m_view.get(), m_document.get());
233
234     // FIXME: Why do we need to call removeAllEventListeners here? When the document is in page cache, this method won't work
235     // fully anyway, because the document won't be able to access its DOMWindow object (due to being frameless).
236     m_document->removeAllEventListeners();
237
238     m_document->setInPageCache(false);
239     // FIXME: We don't call willRemove here. Why is that OK?
240     m_document->detach();
241     m_view->clearFrame();
242
243     clear();
244 }
245
246 void CachedFrame::setCachedFramePlatformData(PassOwnPtr<CachedFramePlatformData> data)
247 {
248     m_cachedFramePlatformData = data;
249 }
250
251 CachedFramePlatformData* CachedFrame::cachedFramePlatformData()
252 {
253     return m_cachedFramePlatformData.get();
254 }
255
256 int CachedFrame::descendantFrameCount() const
257 {
258     int count = m_childFrames.size();
259     for (size_t i = 0; i < m_childFrames.size(); ++i)
260         count += m_childFrames[i]->descendantFrameCount();
261     
262     return count;
263 }
264
265 } // namespace WebCore