WebKit2: Need API to stop loading a WKFrame
[WebKit.git] / Source / WebKit2 / UIProcess / WebFrameProxy.cpp
1 /*
2  * Copyright (C) 2010 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. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #include "WebFrameProxy.h"
27
28 #include "WebCertificateInfo.h"
29 #include "WebContext.h"
30 #include "WebFormSubmissionListenerProxy.h"
31 #include "WebFramePolicyListenerProxy.h"
32 #include "WebPageMessages.h"
33 #include "WebPageProxy.h"
34 #include <WebCore/DOMImplementation.h>
35 #include <WebCore/Image.h>
36 #include <wtf/text/WTFString.h>
37
38 using namespace WebCore;
39 using namespace std;
40
41 namespace WebKit {
42
43 WebFrameProxy::WebFrameProxy(WebPageProxy* page, uint64_t frameID)
44     : m_page(page)
45     , m_parentFrame(0)
46     , m_nextSibling(0)
47     , m_previousSibling(0)
48     , m_firstChild(0)
49     , m_lastChild(0)
50     , m_loadState(LoadStateFinished)
51     , m_isFrameSet(false)
52     , m_frameID(frameID)
53 {
54     WebContext::statistics().wkFrameCount++;
55 }
56
57 WebFrameProxy::~WebFrameProxy()
58 {
59     WebContext::statistics().wkFrameCount--;
60 }
61
62 void WebFrameProxy::disconnect()
63 {
64     m_page = 0;
65     m_parentFrame = 0;
66     m_nextSibling = 0;
67     m_previousSibling = 0;
68     m_firstChild = 0;
69     m_lastChild = 0;
70
71     if (m_activeListener) {
72         m_activeListener->invalidate();
73         m_activeListener = 0;
74     }
75 }
76
77 bool WebFrameProxy::isMainFrame() const
78 {
79     if (!m_page)
80         return false;
81
82     return this == m_page->mainFrame();
83 }
84
85 void WebFrameProxy::stopLoading() const
86 {
87     if (!m_page)
88         return;
89
90     if (!m_page->isValid())
91         return;
92
93     m_page->process()->send(Messages::WebPage::StopLoadingFrame(m_frameID), m_page->pageID());
94 }
95     
96 bool WebFrameProxy::canProvideSource() const
97 {
98     return isDisplayingMarkupDocument();
99 }
100
101 bool WebFrameProxy::canShowMIMEType(const String& mimeType) const
102 {
103     if (!m_page)
104         return false;
105
106     if (m_page->canShowMIMEType(mimeType))
107         return true;
108
109 #if PLATFORM(MAC)
110     // On Mac, we can show PDFs in the main frame.
111     if (isMainFrame() && !mimeType.isEmpty())
112         return WebContext::pdfAndPostScriptMIMETypes().contains(mimeType);
113 #endif
114
115     return false;
116 }
117
118 bool WebFrameProxy::isDisplayingStandaloneImageDocument() const
119 {
120     return Image::supportsType(m_MIMEType);
121 }
122
123 bool WebFrameProxy::isDisplayingMarkupDocument() const
124 {
125     // FIXME: This check should be moved to somewhere in WebCore.
126     // FIXME: This returns false when displaying a web archive.
127     return m_MIMEType == "text/html" || m_MIMEType == "image/svg+xml" || DOMImplementation::isXMLMIMEType(m_MIMEType);
128 }
129
130 void WebFrameProxy::didStartProvisionalLoad(const String& url)
131 {
132     ASSERT(m_loadState == LoadStateFinished);
133     ASSERT(m_provisionalURL.isEmpty());
134     m_loadState = LoadStateProvisional;
135     m_provisionalURL = url;
136 }
137
138 void WebFrameProxy::didReceiveServerRedirectForProvisionalLoad(const String& url)
139 {
140     ASSERT(!url.isEmpty());
141     ASSERT(m_loadState == LoadStateProvisional);
142     ASSERT(!m_provisionalURL.isEmpty());
143     m_provisionalURL = url;
144 }
145
146 void WebFrameProxy::didFailProvisionalLoad()
147 {
148     ASSERT(m_loadState == LoadStateProvisional);
149     ASSERT(!m_provisionalURL.isEmpty());
150     m_loadState = LoadStateFinished;
151     m_provisionalURL = String();
152 }
153
154 void WebFrameProxy::didCommitLoad(const String& contentType, const PlatformCertificateInfo& certificateInfo)
155 {
156     ASSERT(m_loadState == LoadStateProvisional);
157     m_loadState = LoadStateCommitted;
158     m_url = m_provisionalURL;
159     m_provisionalURL = String();
160     m_title = String();
161     m_MIMEType = contentType;
162     m_isFrameSet = false;
163     m_certificateInfo = WebCertificateInfo::create(certificateInfo);
164 }
165
166 void WebFrameProxy::didFinishLoad()
167 {
168     ASSERT(m_loadState == LoadStateCommitted);
169     ASSERT(m_provisionalURL.isEmpty());
170     m_loadState = LoadStateFinished;
171 }
172
173 void WebFrameProxy::didFailLoad()
174 {
175     ASSERT(m_loadState == LoadStateCommitted);
176     ASSERT(m_provisionalURL.isEmpty());
177     ASSERT(!m_url.isEmpty());
178     m_loadState = LoadStateFinished;
179     m_title = String();
180 }
181
182 void WebFrameProxy::didSameDocumentNavigation(const String& url)
183 {
184     m_url = url;
185 }
186
187 void WebFrameProxy::didChangeTitle(const String& title)
188 {
189     m_title = title;
190 }
191
192 void WebFrameProxy::appendChild(WebFrameProxy* child)
193 {
194     ASSERT(child->page() == page());
195     ASSERT(!child->m_parentFrame);
196     ASSERT(!child->m_nextSibling);
197     ASSERT(!child->m_previousSibling);
198
199     child->m_parentFrame = this;
200
201     WebFrameProxy* oldLast = m_lastChild;
202     m_lastChild = child;
203
204     if (oldLast) {
205         ASSERT(!oldLast->m_nextSibling);
206         child->m_previousSibling = oldLast;
207         oldLast->m_nextSibling = child;
208     } else
209         m_firstChild = child;
210 }
211
212 void WebFrameProxy::removeChild(WebFrameProxy* child)
213 {
214     child->m_parentFrame = 0;
215
216     WebFrameProxy*& newLocationForNext = m_firstChild == child ? m_firstChild : child->m_previousSibling->m_nextSibling;
217     WebFrameProxy*& newLocationForPrevious = m_lastChild == child ? m_lastChild : child->m_nextSibling->m_previousSibling;
218     swap(newLocationForNext, child->m_nextSibling);
219     swap(newLocationForPrevious, child->m_previousSibling);
220     child->m_previousSibling = 0;
221     child->m_nextSibling = 0;
222 }
223
224 bool WebFrameProxy::isDescendantOf(const WebFrameProxy* ancestor) const
225 {
226     if (!ancestor)
227         return false;
228
229     if (m_page != ancestor->m_page)
230         return false;
231
232     for (const WebFrameProxy* frame = this; frame; frame = frame->m_parentFrame) {
233         if (frame == ancestor)
234             return true;
235     }
236
237     return false;
238 }
239
240 void WebFrameProxy::dumpFrameTreeToSTDOUT(unsigned indent)
241 {
242     if (!indent && m_parentFrame)
243         printf("NOTE: Printing subtree.\n");
244
245     for (unsigned i = 0; i < indent; ++i)
246         printf(" ");
247     printf("| FRAME %d %s\n", (int)m_frameID, m_url.utf8().data());
248
249     for (WebFrameProxy* child = m_firstChild; child; child = child->m_nextSibling)
250         child->dumpFrameTreeToSTDOUT(indent + 4);
251 }
252
253 void WebFrameProxy::didRemoveFromHierarchy()
254 {
255     if (m_parentFrame)
256         m_parentFrame->removeChild(this);
257 }
258
259 PassRefPtr<ImmutableArray> WebFrameProxy::childFrames()
260 {
261     if (!m_firstChild)
262         return ImmutableArray::create();
263
264     Vector<RefPtr<APIObject> > vector;
265     for (WebFrameProxy* child = m_firstChild; child; child = child->m_nextSibling)
266         vector.append(child);
267
268     return ImmutableArray::adopt(vector);
269 }
270
271 void WebFrameProxy::receivedPolicyDecision(WebCore::PolicyAction action, uint64_t listenerID)
272 {
273     if (!m_page)
274         return;
275
276     ASSERT(m_activeListener);
277     ASSERT(m_activeListener->listenerID() == listenerID);
278     m_page->receivedPolicyDecision(action, this, listenerID);
279 }
280
281 WebFramePolicyListenerProxy* WebFrameProxy::setUpPolicyListenerProxy(uint64_t listenerID)
282 {
283     if (m_activeListener)
284         m_activeListener->invalidate();
285     m_activeListener = WebFramePolicyListenerProxy::create(this, listenerID);
286     return static_cast<WebFramePolicyListenerProxy*>(m_activeListener.get());
287 }
288
289 WebFormSubmissionListenerProxy* WebFrameProxy::setUpFormSubmissionListenerProxy(uint64_t listenerID)
290 {
291     if (m_activeListener)
292         m_activeListener->invalidate();
293     m_activeListener = WebFormSubmissionListenerProxy::create(this, listenerID);
294     return static_cast<WebFormSubmissionListenerProxy*>(m_activeListener.get());
295 }
296
297 void WebFrameProxy::getWebArchive(PassRefPtr<DataCallback> callback)
298 {
299     if (!m_page) {
300         callback->invalidate();
301         return;
302     }
303
304     m_page->getWebArchiveOfFrame(this, callback);
305 }
306
307 void WebFrameProxy::getMainResourceData(PassRefPtr<DataCallback> callback)
308 {
309     if (!m_page) {
310         callback->invalidate();
311         return;
312     }
313
314     m_page->getMainResourceDataOfFrame(this, callback);
315 }
316
317 void WebFrameProxy::getResourceData(WebURL* resourceURL, PassRefPtr<DataCallback> callback)
318 {
319     if (!m_page) {
320         callback->invalidate();
321         return;
322     }
323
324     m_page->getResourceDataFromFrame(this, resourceURL, callback);
325 }
326
327 } // namespace WebKit