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